From 9f96eea259eec4ee7e0d469dd8ecc56ce1462236 Mon Sep 17 00:00:00 2001 From: dphuang2 Date: Thu, 28 Mar 2024 14:56:45 -0700 Subject: [PATCH] remove random console.log statements format fix-request-media-type-object-missing-schema fix bug in fix-passthrough-refs fix incorrect ref publish getresponse --- .../src/util/fix-passthrough-refs.ts | 5 +- ...equest-media-type-object-missing-schema.ts | 45 +- .../src/util/validate-schema-name.ts | 1 - .../fix-passthrough-refs.test.ts.snap | 48 + .../test/util/fix-passthrough-refs.test.ts | 61 + .../from-custom-request_box.com.yaml | 2 +- .../from-custom-request_digitalocean.com.yaml | 22 +- .../from-custom-request_getresponse.com.yaml | 7924 ++++ sdks/db/category-cache.yaml | 1 + sdks/db/custom-request-last-fetched.yaml | 85 +- .../custom-request-specs/getresponse.com.yaml | 35044 +++++++++++++++ .../get-response-fixed-spec.yaml | 35084 ++++++++++++++++ sdks/db/fixed-specs/box-fixed-spec.yaml | 2 - .../fixed-specs/digital-ocean-fixed-spec.yaml | 764 +- .../fixed-specs/get-response-fixed-spec.yaml | 32713 ++++++++++++++ .../customer-io-data-pipelines.json | 4 +- .../customer-io-journeys-app.json | 4 +- .../customer-io-journeys-track.json | 4 +- .../get-response.json | 3 + .../getresponse/openapi.yaml | 35044 +++++++++++++++ .../getresponse.com.yaml | 529 + sdks/db/progress/get-response-progress.yaml | 853 + .../from-custom-request_box.com.json | 454 +- ...tom-request_customer.io_DatePipelines.json | 12 +- ...ustom-request_customer.io_JourneysApp.json | 22 +- ...tom-request_customer.io_JourneysTrack.json | 12 +- .../from-custom-request_digitalocean.com.json | 139 +- .../from-custom-request_getresponse.com.json | 11613 +++++ ...from-custom-request_peachpayments.com.json | 4 +- .../from-custom-request_getresponse.com.json | 51 + .../sportsdata.io_nfl-v3-projections_1.0.json | 2 +- sdks/db/spec-data/zeno.fm_0.6-99cfdac.json | 2 +- sdks/publish.yaml | 55 +- sdks/src/collect-from-custom-requests.ts | 8 +- 34 files changed, 159247 insertions(+), 1369 deletions(-) create mode 100644 generator/konfig-dash/packages/konfig-cli/test/util/__snapshots__/fix-passthrough-refs.test.ts.snap create mode 100644 generator/konfig-dash/packages/konfig-cli/test/util/fix-passthrough-refs.test.ts create mode 100644 sdks/db/cached-method-objects/from-custom-request_getresponse.com.yaml create mode 100644 sdks/db/custom-request-specs/getresponse.com.yaml create mode 100644 sdks/db/fixed-specs-cache/get-response-fixed-spec.yaml create mode 100644 sdks/db/fixed-specs/get-response-fixed-spec.yaml create mode 100644 sdks/db/generate-repository-description-cache/get-response.json create mode 100644 sdks/db/intermediate-fixed-specs/getresponse/openapi.yaml create mode 100644 sdks/db/processed-custom-request-cache/getresponse.com.yaml create mode 100644 sdks/db/progress/get-response-progress.yaml create mode 100644 sdks/db/published/from-custom-request_getresponse.com.json create mode 100644 sdks/db/spec-data/from-custom-request_getresponse.com.json diff --git a/generator/konfig-dash/packages/konfig-cli/src/util/fix-passthrough-refs.ts b/generator/konfig-dash/packages/konfig-cli/src/util/fix-passthrough-refs.ts index fb54b6f31f..fd81d008dd 100644 --- a/generator/konfig-dash/packages/konfig-cli/src/util/fix-passthrough-refs.ts +++ b/generator/konfig-dash/packages/konfig-cli/src/util/fix-passthrough-refs.ts @@ -58,7 +58,6 @@ export async function fixPassthroughRefs({ } let passthroughRefs = collectPassthroughRefs() - console.log(passthroughRefs) // iterate through all passthrough refs and replace them with the reffed schema for (const [source, destination] of passthroughRefs) { recurseObject(spec.spec, ({ value: schema }) => { @@ -74,6 +73,10 @@ export async function fixPassthroughRefs({ // get name of schema from ref const ref = schema['$ref'] + + // check that ref is referring to something with "components/schemas" + if (!ref.startsWith('#/components/schemas/')) return + const schemaName = ref.split('/').pop() if (schemaName === undefined) return // check if schemaName matches name of passthrough ref (e.g. "source") diff --git a/generator/konfig-dash/packages/konfig-cli/src/util/fix-request-media-type-object-missing-schema.ts b/generator/konfig-dash/packages/konfig-cli/src/util/fix-request-media-type-object-missing-schema.ts index 814721d764..00e0287731 100644 --- a/generator/konfig-dash/packages/konfig-cli/src/util/fix-request-media-type-object-missing-schema.ts +++ b/generator/konfig-dash/packages/konfig-cli/src/util/fix-request-media-type-object-missing-schema.ts @@ -1,21 +1,32 @@ import { Spec, getOperations, resolveRef } from 'konfig-lib' export async function fixRequestMediaTypeObjectMissingSchema({ - spec, - }: { - spec: Spec - }): Promise { - let numberOfMissingRequestSchemasInMediaTypeObjects = 0 - getOperations({ spec: spec.spec }).forEach(({ operation }) => { - if (operation.requestBody) { - const requestBody = resolveRef({refOrObject: operation.requestBody, $ref: spec.$ref}) - Object.values(requestBody.content).forEach((mediaTypeObject) => { - if (!mediaTypeObject.schema) { - mediaTypeObject.schema = { description: "WARNING: Missing schema in media type object. Missing schema has been filled with this AnyType schema." } - numberOfMissingRequestSchemasInMediaTypeObjects++ - } - }) + spec, +}: { + spec: Spec +}): Promise { + let numberOfMissingRequestSchemasInMediaTypeObjects = 0 + getOperations({ spec: spec.spec }).forEach(({ operation }) => { + if (operation.requestBody) { + const requestBody = resolveRef({ + refOrObject: operation.requestBody, + $ref: spec.$ref, + }) + if (requestBody.content === undefined || requestBody.content === null) { + throw Error( + `Missing content in request body for ${operation.operationId}` + ) } - }) - return numberOfMissingRequestSchemasInMediaTypeObjects; - } \ No newline at end of file + Object.values(requestBody.content).forEach((mediaTypeObject) => { + if (!mediaTypeObject.schema) { + mediaTypeObject.schema = { + description: + 'WARNING: Missing schema in media type object. Missing schema has been filled with this AnyType schema.', + } + numberOfMissingRequestSchemasInMediaTypeObjects++ + } + }) + } + }) + return numberOfMissingRequestSchemasInMediaTypeObjects +} diff --git a/generator/konfig-dash/packages/konfig-cli/src/util/validate-schema-name.ts b/generator/konfig-dash/packages/konfig-cli/src/util/validate-schema-name.ts index 2ae625f458..ffbc687849 100644 --- a/generator/konfig-dash/packages/konfig-cli/src/util/validate-schema-name.ts +++ b/generator/konfig-dash/packages/konfig-cli/src/util/validate-schema-name.ts @@ -29,7 +29,6 @@ export function validateSchemaName({ const nameWithoutX = name.replace(/X/g, '') const isCamelcase = camelcase(nameWithoutX, { pascalCase: true }) === nameWithoutX - console.log(name, isCamelcase) const isNonEmpty = nameSchema.safeParse(name).success const isUnique = spec.components === undefined || diff --git a/generator/konfig-dash/packages/konfig-cli/test/util/__snapshots__/fix-passthrough-refs.test.ts.snap b/generator/konfig-dash/packages/konfig-cli/test/util/__snapshots__/fix-passthrough-refs.test.ts.snap new file mode 100644 index 0000000000..c316f6ab89 --- /dev/null +++ b/generator/konfig-dash/packages/konfig-cli/test/util/__snapshots__/fix-passthrough-refs.test.ts.snap @@ -0,0 +1,48 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`fixPassthroughRefs request body shouldn't be shortened 1`] = ` +{ + "components": { + "requestBodies": { + "TestRequestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PassthroughSchema", + }, + }, + }, + }, + }, + "schemas": { + "PassthroughSchema": { + "properties": { + "test": { + "type": "string", + }, + }, + "type": "object", + }, + }, + }, + "info": { + "title": "Test API", + "version": "1.0.0", + }, + "openapi": "3.0.0", + "paths": { + "/test": { + "post": { + "requestBody": { + "$ref": "#/components/requestBodies/RequestBody", + }, + "responses": { + "200": { + "description": "Successful response", + }, + }, + }, + }, + }, +} +`; diff --git a/generator/konfig-dash/packages/konfig-cli/test/util/fix-passthrough-refs.test.ts b/generator/konfig-dash/packages/konfig-cli/test/util/fix-passthrough-refs.test.ts new file mode 100644 index 0000000000..fa9ae26a5a --- /dev/null +++ b/generator/konfig-dash/packages/konfig-cli/test/util/fix-passthrough-refs.test.ts @@ -0,0 +1,61 @@ +import { Spec, parseSpec, recurseObject } from 'konfig-lib' +import { fixPassthroughRefs } from '../../src/util/fix-passthrough-refs' + +describe('fixPassthroughRefs', () => { + it(`request body shouldn't be shortened`, async () => { + const openapi: Spec['spec'] = { + openapi: '3.0.0', + info: { + title: 'Test API', + version: '1.0.0', + }, + paths: { + '/test': { + post: { + requestBody: { + $ref: '#/components/requestBodies/RequestBody', + }, + responses: { + '200': { + description: 'Successful response', + }, + }, + }, + }, + }, + components: { + requestBodies: { + TestRequestBody: { + content: { + 'application/json': { + schema: { + $ref: '#/components/schemas/RequestBody', + }, + }, + }, + }, + }, + schemas: { + RequestBody: { + $ref: '#/components/schemas/PassthroughSchema', + }, + PassthroughSchema: { + type: 'object', + properties: { + test: { + type: 'string', + }, + }, + }, + }, + }, + } + + const spec = await parseSpec(JSON.stringify(openapi)) + + const fixedSpec = await fixPassthroughRefs({ spec }) + + // snapshot expect + expect(spec.spec).toMatchSnapshot() + }) +}) diff --git a/sdks/db/cached-method-objects/from-custom-request_box.com.yaml b/sdks/db/cached-method-objects/from-custom-request_box.com.yaml index ff2ab6e83b..c5b41d3592 100644 --- a/sdks/db/cached-method-objects/from-custom-request_box.com.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_box.com.yaml @@ -1,4 +1,4 @@ -hash: 5bc3c66e5a79f8838fc3d59af06be08cb3bb71cb8b809eb0a652be12a58d7805 +hash: 22ce7349507d865bb698fdc82fe8215978a81a02a5b2e9b9a2d57c2427a13f64 methodObjects: - url: /authorize method: authorize diff --git a/sdks/db/cached-method-objects/from-custom-request_digitalocean.com.yaml b/sdks/db/cached-method-objects/from-custom-request_digitalocean.com.yaml index 5194d3d544..42be416ac1 100644 --- a/sdks/db/cached-method-objects/from-custom-request_digitalocean.com.yaml +++ b/sdks/db/cached-method-objects/from-custom-request_digitalocean.com.yaml @@ -1,4 +1,4 @@ -hash: 34dbab87b60c92915d6c3607dcc8bf6809b49decfea3b148ee3ad76080242646 +hash: 26d7310c960ca6e2183ea9a808b5fe3e090effffc55221e04ca36c6005ab2cb5 methodObjects: - url: /v2/1-clicks method: list @@ -9634,7 +9634,7 @@ apiDescription: > how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The - POST request includes all of the attributes necessary to create a new object. + POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| @@ -9971,22 +9971,22 @@ apiDescription: > If the `ratelimit-remaining` reaches zero, subsequent requests will receive - a 429 error code until the request reset has been reached. + a 429 error code until the request reset has been reached. `ratelimit-remaining` reaching zero can also indicate that the "burst limit" - of 250 + of 250 requests per minute limit was met, even if the 5,000 requests per hour limit - was not. + was not. In this case, the 429 error response will include a retry-after header to - indicate how + indicate how long to wait (in seconds) until the request may be retried. - You can see the format of the response in the examples. + You can see the format of the response in the examples. **Note:** The following endpoints have special rate limit requirements that @@ -10001,11 +10001,11 @@ apiDescription: > can be made per 60 seconds. * Only 5 requests to any and all `v2/cdn/endpoints` can be made per 10 - seconds. This includes `v2/cdn/endpoints`, + seconds. This includes `v2/cdn/endpoints`, `v2/cdn/endpoints/$ENDPOINT_ID`, and `v2/cdn/endpoints/$ENDPOINT_ID/cache`. * Only 50 strings within the `files` json struct in the `v2/cdn/endpoints/$ENDPOINT_ID/cache` - [payload](https://docs.digitalocean.com/reference/api/api-reference/#operation/cdn_purge_cache) + [payload](https://docs.digitalocean.com/reference/api/api-reference/#operation/cdn_purge_cache) can be requested every 20 seconds. ### Sample Rate Limit Headers @@ -10051,7 +10051,7 @@ apiDescription: > `curl` command. This will allow us to demonstrate the various endpoints in a simple, textual format. - + These examples assume that you are using a Linux or macOS command line. To run these commands on a Windows machine, you can either use cmd.exe, PowerShell, or WSL: @@ -10076,7 +10076,7 @@ apiDescription: > a Windows machine. Install WSL with our [community - tutorial](https://www.digitalocean.com/community/tutorials/how-to-install-the-windows-subsystem-for-linux-2-on-microsoft-windows-10), + tutorial](https://www.digitalocean.com/community/tutorials/how-to-install-the-windows-subsystem-for-linux-2-on-microsoft-windows-10), then follow this API documentation normally. diff --git a/sdks/db/cached-method-objects/from-custom-request_getresponse.com.yaml b/sdks/db/cached-method-objects/from-custom-request_getresponse.com.yaml new file mode 100644 index 0000000000..bc0c4923fd --- /dev/null +++ b/sdks/db/cached-method-objects/from-custom-request_getresponse.com.yaml @@ -0,0 +1,7924 @@ +hash: 45db9f4f07863d6780d4896b07f2feedc20d6e6abe72e4c6ad1427fa7a0d43fc +methodObjects: + - url: /webinars/{webinarId} + method: getById + httpMethod: get + tag: Webinars + typeScriptTag: webinars + description: Get a webinar by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /contacts/{contactId} + method: deleteById + httpMethod: delete + tag: Contacts + typeScriptTag: contacts + description: Delete a contact by contact ID + parameters: + - name: messageId + schema: string + required: false + description: >- + > + + The ID of a message (such as a newsletter, an autoresponder, or an + RSS-newsletter). + + When passed, this method will simulate the unsubscribe process, as if + the contact clicked the unsubscribe link in a given message. + - name: ipAddress + schema: string + description: >- + This makes it possible to pass the IP from which the contact + unsubscribed. Used only if the `messageId` was send. + responses: + - statusCode: '204' + description: Empty response. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /contacts/{contactId} + method: getDetailsById + httpMethod: get + tag: Contacts + typeScriptTag: contacts + description: Get contact details by contact ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /contacts/{contactId} + method: updateDetails + httpMethod: post + tag: Contacts + typeScriptTag: contacts + description: Update contact details + parameters: [] + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '409' + description: '' + - statusCode: '429' + description: '' + - url: /contacts/{contactId}/activities + method: getListOfActivities + httpMethod: get + tag: Contacts + typeScriptTag: contacts + description: Get a list of contact activities + parameters: + - name: query[createdOn][from] + schema: undefined + required: false + description: '' + - name: query[createdOn][to] + schema: undefined + required: false + description: '' + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /campaigns/{campaignId}/contacts + method: getSingleCampaignContacts + httpMethod: get + tag: Contacts + typeScriptTag: contacts + description: Get contacts from a single campaign + parameters: + - name: query[email] + schema: string + required: false + description: Search contacts by email + - name: query[name] + schema: string + required: false + description: Search contacts by name + - name: query[createdOn][from] + schema: undefined + required: false + description: Count data from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Count data to this date + - name: sort[email] + schema: string + required: false + description: Sort contacts by email + - name: sort[name] + schema: string + required: false + description: Sort contacts by name + - name: sort[createdOn] + schema: string + required: false + description: Sort contacts by creation date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /contacts/{contactId}/custom-fields + method: upsertCustomFields + httpMethod: post + tag: Contacts + typeScriptTag: contacts + description: Upsert the custom fields of a contact + parameters: + - name: customFieldValues + schema: array + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /contacts/{contactId}/tags + method: upsertContactTags + httpMethod: post + tag: Contacts + typeScriptTag: contacts + description: Upsert the tags of a contact + parameters: + - name: tags + schema: array + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /search-contacts/{searchContactId} + method: deleteById + httpMethod: delete + tag: Search Contacts + typeScriptTag: searchContacts + description: Delete search contacts + parameters: [] + responses: + - statusCode: '204' + description: Delete search contacts. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /search-contacts/{searchContactId} + method: byContactId + httpMethod: get + tag: Search Contacts + typeScriptTag: searchContacts + description: Get search contacts by contact ID. + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: Search contact details. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /search-contacts/{searchContactId} + method: updateSpecifiedContacts + httpMethod: post + tag: Search Contacts + typeScriptTag: searchContacts + description: Update search contacts + parameters: [] + responses: + - statusCode: '200' + description: Search contact details. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '409' + description: '' + - statusCode: '429' + description: '' + - url: /search-contacts/{searchContactId}/contacts + method: byId + httpMethod: get + tag: Search Contacts + typeScriptTag: searchContacts + description: Get contacts by search contacts ID + parameters: + - name: sort[name] + schema: string + required: false + description: Sort by name + example: desc + - name: sort[email] + schema: string + required: false + description: Sort by email + example: desc + - name: sort[createdOn] + schema: string + required: false + description: Sort by creation date + example: asc + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /search-contacts/{searchContactId}/custom-fields + method: upsertCustomFieldsByContactId + httpMethod: post + tag: Search Contacts + typeScriptTag: searchContacts + description: Upsert custom fields by search contacts + parameters: + - name: customFieldValues + schema: array + description: '' + responses: + - statusCode: '202' + description: Upsert custom fields by searchContactId. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /transactional-emails/templates/{transactionalTemplateId} + method: deleteTemplate + httpMethod: delete + tag: Transactional Emails Templates + typeScriptTag: transactionalEmailsTemplates + description: Delete transactional email template + parameters: [] + responses: + - statusCode: '204' + description: Delete transactional email template + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /transactional-emails/templates/{transactionalTemplateId} + method: getById + httpMethod: get + tag: Transactional Emails Templates + typeScriptTag: transactionalEmailsTemplates + description: Get a single template by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /transactional-emails/templates/{transactionalTemplateId} + method: updateTemplate + httpMethod: post + tag: Transactional Emails Templates + typeScriptTag: transactionalEmailsTemplates + description: Update transactional email template + parameters: + - name: subject + schema: string + description: '' + example: Order Confirmation - Example Shop + - name: content + schema: object + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /transactional-emails/{transactionalEmailId} + method: getDetailsById + httpMethod: get + tag: Transactional Emails + typeScriptTag: transactionalEmails + description: Get transactional email details by transactional email ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /from-fields/{fromFieldId} + method: deleteAddress + httpMethod: delete + tag: From Fields + typeScriptTag: fromFields + description: Delete 'From' address + parameters: + - name: fromFieldIdToReplaceWith + schema: string + required: false + description: The 'From' address ID that should replace the deleted 'From' address + responses: + - statusCode: '204' + description: Delete 'From' address. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /from-fields/{fromFieldId} + method: getSingleAddressById + httpMethod: get + tag: From Fields + typeScriptTag: fromFields + description: Get a single 'From' address by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /from-fields/{fromFieldId}/default + method: setFromAddressAsDefault + httpMethod: post + tag: From Fields + typeScriptTag: fromFields + description: Set a 'From' address as default + parameters: [] + responses: + - statusCode: '200' + description: Set a 'From' address as default. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /rss-newsletters/{rssNewsletterId} + method: deleteNewsletter + httpMethod: delete + tag: RSS Newsletters + typeScriptTag: rssNewsletters + description: Delete RSS newsletter + parameters: [] + responses: + - statusCode: '204' + description: Delete RSS newsletter. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /rss-newsletters/{rssNewsletterId} + method: getById + httpMethod: get + tag: RSS Newsletters + typeScriptTag: rssNewsletters + description: Get RSS newsletter by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /rss-newsletters/{rssNewsletterId} + method: updateNewsletter + httpMethod: post + tag: RSS Newsletters + typeScriptTag: rssNewsletters + description: Update RSS newsletter + parameters: + - name: rssNewsletterId + schema: string + required: true + description: '' + example: dGer + - name: href + schema: string + required: true + description: '' + example: https://api.getresponse.com/v3/rss-newsletters/dGer + - name: rssFeedUrl + schema: string + required: false + description: '' + example: http://blog.getresponse.com + - name: subject + schema: string + required: false + description: '' + example: My rss to newsletters + - name: name + schema: string + required: false + description: '' + example: rsstest0 + - name: status + schema: string + required: false + description: '' + - name: editor + schema: string + required: false + description: '' + - name: fromField + schema: object + required: false + description: '' + - name: replyTo + schema: object + required: false + description: '' + - name: content + schema: object + required: false + description: '' + - name: sendSettings + schema: object + required: false + description: '' + - name: createdOn + schema: string + required: false + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /rss-newsletters/{rssNewsletterId}/statistics + method: getStatisticsById + httpMethod: get + tag: RSS Newsletters + typeScriptTag: rssNewsletters + description: Get RSS newsletter statistics by ID + parameters: + - name: query[groupBy] + schema: string + required: false + description: Group results by time interval + - name: query[createdOn][from] + schema: undefined + required: false + description: Count data from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Count data to this date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/taxes + method: getList + httpMethod: get + tag: Taxes + typeScriptTag: taxes + description: Get a list of taxes + parameters: + - name: query[name] + schema: string + required: false + description: Search tax by name + - name: query[createdOn][from] + schema: undefined + required: false + description: Search tax created from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Search tax created to this date + - name: sort[createdOn] + schema: string + required: false + description: Sort by date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/taxes + method: createNewTax + httpMethod: post + tag: Taxes + typeScriptTag: taxes + description: Create tax + parameters: + - name: taxId + schema: string + description: '' + example: Sk + - name: href + schema: string + description: '' + example: https://api.getresponse.com/v3/shops/pf3/taxes/Sk + - name: name + schema: string + description: '' + example: VAT + - name: rate + schema: number + description: '' + example: 23 + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/taxes/{taxId} + method: deleteById + httpMethod: delete + tag: Taxes + typeScriptTag: taxes + description: Delete tax by ID + parameters: [] + responses: + - statusCode: '204' + description: Delete tax + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/taxes/{taxId} + method: getSingleById + httpMethod: get + tag: Taxes + typeScriptTag: taxes + description: Get a single tax by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/taxes/{taxId} + method: updateShopTax + httpMethod: post + tag: Taxes + typeScriptTag: taxes + description: Update tax + parameters: + - name: taxId + schema: string + description: '' + example: Sk + - name: href + schema: string + description: '' + example: https://api.getresponse.com/v3/shops/pf3/taxes/Sk + - name: name + schema: string + description: '' + example: VAT + - name: rate + schema: number + description: '' + example: 23 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /custom-events/{customEventId} + method: deleteEventById + httpMethod: delete + tag: Custom Events + typeScriptTag: customEvents + description: Delete a custom event by custom event ID + parameters: [] + responses: + - statusCode: '204' + description: Delete custom event + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /custom-events/{customEventId} + method: getById + httpMethod: get + tag: Custom Events + typeScriptTag: customEvents + description: Get custom events by custom event ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /custom-events/{customEventId} + method: updateDetails + httpMethod: post + tag: Custom Events + typeScriptTag: customEvents + description: Update custom event details + parameters: + - name: name + schema: string + required: true + description: '' + example: sample_custom_event + - name: attributes + schema: array + required: true + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /forms/{formId} + method: getById + httpMethod: get + tag: Forms + typeScriptTag: forms + description: Get form by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /forms/{formId}/variants + method: getListOfVariants + httpMethod: get + tag: Forms + typeScriptTag: forms + description: Get the list of form variants (A/B tests) + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /landing-pages/{landingPageId} + method: getById + httpMethod: get + tag: Legacy Landing Pages + typeScriptTag: legacyLandingPages + description: Get single landing page by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /imports/{importId} + method: getImportDetailsById + httpMethod: get + tag: Imports + typeScriptTag: imports + description: Get import details by ID. + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /statistics/sms/{smsId} + method: getMessageStatistics + httpMethod: get + tag: Sms + typeScriptTag: sms + description: Get details for the SMS message statistics + parameters: + - name: query[createdOn][from] + schema: string + description: Get statistics for a single SMS from this date + example: '2023-01-20' + - name: query[createdOn][to] + schema: string + description: Get statistics for a single SMS to this date + example: '2023-01-20' + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /predefined-fields/{predefinedFieldId} + method: deleteField + httpMethod: delete + tag: Predefined Fields + typeScriptTag: predefinedFields + description: Delete a predefined field + parameters: [] + responses: + - statusCode: '204' + description: Delete a predefined field. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /predefined-fields/{predefinedFieldId} + method: getById + httpMethod: get + tag: Predefined Fields + typeScriptTag: predefinedFields + description: Get a predefined field by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /predefined-fields/{predefinedFieldId} + method: updateField + httpMethod: post + tag: Predefined Fields + typeScriptTag: predefinedFields + description: Update a predefined field + parameters: + - name: value + schema: string + required: true + description: '' + example: my_new_value + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/categories + method: list + httpMethod: get + tag: Categories + typeScriptTag: categories + description: Get the shop categories list + parameters: + - name: query[name] + schema: string + required: false + description: Search category by name + - name: query[parentId] + schema: string + required: false + description: Search categories by their parent + - name: query[externalId] + schema: string + required: false + description: Search categories by external ID + - name: search[createdAt][from] + schema: string + required: false + description: Show categories starting from this date + - name: search[createdAt][to] + schema: string + required: false + description: Show categories starting to this date + - name: sort[name] + schema: string + required: false + description: Sort by name + - name: sort[createdAt] + schema: string + required: false + description: Sort by date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/categories + method: createNewCategory + httpMethod: post + tag: Categories + typeScriptTag: categories + description: Create category + parameters: [] + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/categories/{categoryId} + method: deleteCategory + httpMethod: delete + tag: Categories + typeScriptTag: categories + description: Delete category + parameters: [] + responses: + - statusCode: '204' + description: Delete category + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/categories/{categoryId} + method: getById + httpMethod: get + tag: Categories + typeScriptTag: categories + description: Get a single category by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/categories/{categoryId} + method: updateCategoryProperties + httpMethod: post + tag: Categories + typeScriptTag: categories + description: Update category + parameters: [] + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /suppressions/{suppressionId} + method: deleteById + httpMethod: delete + tag: Suppressions + typeScriptTag: suppressions + description: Deletes a given suppression list by ID + parameters: [] + responses: + - statusCode: '204' + description: Suppression list deleted successfully. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /suppressions/{suppressionId} + method: getSuppressionListById + httpMethod: get + tag: Suppressions + typeScriptTag: suppressions + description: Get a suppression list by ID + parameters: [] + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /suppressions/{suppressionId} + method: updateById + httpMethod: post + tag: Suppressions + typeScriptTag: suppressions + description: Update a suppression list by ID + parameters: + - name: name + schema: string + description: '' + example: suppression-name + - name: masks + schema: array + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '409' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/orders + method: getList + httpMethod: get + tag: Orders + typeScriptTag: orders + description: Get the list of orders + parameters: + - name: query[description] + schema: string + required: false + description: Search order by description + - name: query[status] + schema: string + required: false + description: Search order by status + - name: query[externalId] + schema: string + required: false + description: Search order by external ID + - name: query[processedAt][from] + schema: string + required: false + description: Show orders processed from this date + - name: query[processedAt][to] + schema: string + required: false + description: Show orders processed to this date + - name: sort[createdOn] + schema: string + required: false + description: Sort by date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/orders + method: createNewOrder + httpMethod: post + tag: Orders + typeScriptTag: orders + description: Create order + parameters: + - name: additionalFlags + schema: string + required: false + description: >- + The additional flags parameter with the value `skipAutomation` will + skip the triggering `Make a purchase` element in an automated workflow + example: skipAutomation + - name: description + schema: string + description: '' + example: More information about order. + - name: orderId + schema: string + description: '' + example: fOh + - name: href + schema: string + description: '' + example: https://api.getresponse.com/v3/shops/pf3/orders/fOh + - name: contactId + schema: string + description: '' + example: k8u + - name: orderUrl + schema: string + description: '' + example: https://somedomain.com/orders/order446 + - name: externalId + schema: string + description: '' + example: DH71239 + - name: totalPrice + schema: number + description: '' + example: 716 + - name: totalPriceTax + schema: number + description: '' + example: 358.67 + - name: currency + schema: string + description: '' + example: PLN + - name: status + schema: string + description: '' + example: NEW + - name: cartId + schema: string + description: '' + example: QBNgBR + - name: shippingPrice + schema: number + description: '' + example: 23 + - name: shippingAddress + schema: object + description: '' + - name: billingStatus + schema: string + description: '' + example: PENDING + - name: billingAddress + schema: object + description: '' + - name: processedAt + schema: string + description: '' + - name: metaFields + schema: array + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/orders/{orderId} + method: deleteOrder + httpMethod: delete + tag: Orders + typeScriptTag: orders + description: Delete order + parameters: [] + responses: + - statusCode: '204' + description: Delete order + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/orders/{orderId} + method: getById + httpMethod: get + tag: Orders + typeScriptTag: orders + description: Get a single order by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/orders/{orderId} + method: updateOrder + httpMethod: post + tag: Orders + typeScriptTag: orders + description: Update order + parameters: + - name: additionalFlags + schema: string + required: false + description: >- + The additional flags parameter with the value `skipAutomation` will + skip the triggering `Make a purchase` element in an automated workflow + example: skipAutomation + - name: description + schema: string + description: '' + example: More information about order. + - name: orderId + schema: string + description: '' + example: fOh + - name: href + schema: string + description: '' + example: https://api.getresponse.com/v3/shops/pf3/orders/fOh + - name: contactId + schema: string + description: '' + example: k8u + - name: orderUrl + schema: string + description: '' + example: https://somedomain.com/orders/order446 + - name: externalId + schema: string + description: '' + example: DH71239 + - name: totalPrice + schema: number + description: '' + example: 716 + - name: totalPriceTax + schema: number + description: '' + example: 358.67 + - name: currency + schema: string + description: '' + example: PLN + - name: status + schema: string + description: '' + example: NEW + - name: cartId + schema: string + description: '' + example: QBNgBR + - name: shippingPrice + schema: number + description: '' + example: 23 + - name: shippingAddress + schema: object + description: '' + - name: billingStatus + schema: string + description: '' + example: PENDING + - name: billingAddress + schema: object + description: '' + - name: processedAt + schema: string + description: '' + - name: metaFields + schema: array + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/products + method: getList + httpMethod: get + tag: Products + typeScriptTag: products + description: Get a product list. + parameters: + - name: query[name] + schema: string + required: false + description: Search products by name + - name: query[vendor] + schema: string + required: false + description: Search products by vendor + - name: query[category] + schema: string + required: false + description: Search products by category name + - name: query[categoryId] + schema: string + required: false + description: Search products by category ID + - name: query[externalId] + schema: string + required: false + description: Search products by external ID + - name: query[variantName] + schema: string + required: false + description: Search products by product variant name + - name: query[metaFieldNames] + schema: string + required: false + description: >- + Search products by meta field name (the list of names must be + separated by a comma [,]) + - name: query[metaFieldValues] + schema: string + required: false + description: >- + Search products by meta field value (the list of values must be + separated by a comma [,]) + - name: query[createdOn][from] + schema: undefined + required: false + description: Search products created from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Search products created to this date + - name: sort[name] + schema: string + required: false + description: Sort by name + - name: sort[createdOn] + schema: string + required: false + description: Sort by date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/products + method: createProduct + httpMethod: post + tag: Products + typeScriptTag: products + description: Create product + parameters: + - name: createdOn + schema: string + description: '' + - name: updatedOn + schema: string + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/products/{productId} + method: deleteProduct + httpMethod: delete + tag: Products + typeScriptTag: products + description: Delete product + parameters: [] + responses: + - statusCode: '204' + description: Delete product + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/products/{productId} + method: getByShopIdAndProductId + httpMethod: get + tag: Products + typeScriptTag: products + description: Get a single product by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/products/{productId} + method: updateProduct + httpMethod: post + tag: Products + typeScriptTag: products + description: Update product + parameters: + - name: createdOn + schema: string + description: '' + - name: updatedOn + schema: string + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/products/{productId}/categories + method: upsertCategories + httpMethod: post + tag: Products + typeScriptTag: products + description: Upsert product categories + parameters: + - name: categories + schema: array + required: true + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/products/{productId}/meta-fields + method: upsertMetaFields + httpMethod: post + tag: Products + typeScriptTag: products + description: Upsert product meta fields + parameters: + - name: metaFields + schema: array + required: true + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId} + method: deleteShop + httpMethod: delete + tag: Shops + typeScriptTag: shops + description: Delete shop + parameters: [] + responses: + - statusCode: '204' + description: Delete a shop + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId} + method: getById + httpMethod: get + tag: Shops + typeScriptTag: shops + description: Get a single shop by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId} + method: updatePreferences + httpMethod: post + tag: Shops + typeScriptTag: shops + description: Update shop + parameters: + - name: createdOn + schema: string + description: '' + - name: updatedOn + schema: string + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /popups/{popupId} + method: getFormOrPopupById + httpMethod: get + tag: Forms and Popups + typeScriptTag: formsAndPopups + description: Get a single form or popup by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /statistics/popups/{popupId}/performance + method: getPerformanceStatsSinglePopup + httpMethod: get + tag: Form and Popup + typeScriptTag: formAndPopup + description: Get statistics for a single form or popup + parameters: + - name: query[date][from] + schema: string + required: false + description: Get statistics for a single form or popup from this date + example: '2023-01-10' + - name: query[date][to] + schema: string + required: false + description: Get statistics for a single form or popup to this date + example: '2023-01-20' + - name: query[location] + schema: string + required: false + description: Form or popup statistics by location + - name: query[device] + schema: string + required: false + description: Form or popup statistics by device + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /splittests/{splittestId} + method: getSingleAbTestById + httpMethod: get + tag: A/B tests + typeScriptTag: aBTests + description: Get a single A/B test. + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/carts + method: getShopCarts + httpMethod: get + tag: Carts + typeScriptTag: carts + description: Get shop carts + parameters: + - name: query[createdOn][from] + schema: undefined + required: false + description: Search carts created from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Search carts created to this date + - name: query[externalId] + schema: string + required: false + description: Search cart by external ID + - name: sort[createdOn] + schema: string + required: false + description: Sort by date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/carts + method: createNewCart + httpMethod: post + tag: Carts + typeScriptTag: carts + description: Create cart + parameters: + - name: createdOn + schema: string + description: '' + - name: updatedOn + schema: string + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/carts/{cartId} + method: deleteCart + httpMethod: delete + tag: Carts + typeScriptTag: carts + description: Delete cart + parameters: [] + responses: + - statusCode: '204' + description: Delete cart + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/carts/{cartId} + method: getByIdInShopContext + httpMethod: get + tag: Carts + typeScriptTag: carts + description: Get cart by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/carts/{cartId} + method: updateCartProperties + httpMethod: post + tag: Carts + typeScriptTag: carts + description: Update cart + parameters: + - name: createdOn + schema: string + description: '' + - name: updatedOn + schema: string + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /file-library/files/{fileId} + method: deleteFileById + httpMethod: delete + tag: File Library + typeScriptTag: fileLibrary + description: Delete file by file ID + parameters: [] + responses: + - statusCode: '204' + description: Delete file + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /file-library/files/{fileId} + method: getFileById + httpMethod: get + tag: File Library + typeScriptTag: fileLibrary + description: Get file by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /file-library/folders/{folderId} + method: deleteFolderById + httpMethod: delete + tag: File Library + typeScriptTag: fileLibrary + description: Delete folder by folder ID + parameters: [] + responses: + - statusCode: '204' + description: Delete folder + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /ab-tests/subject/{abTestId} + method: getSingleById + httpMethod: get + tag: A/B tests - subject + typeScriptTag: aBTestsSubject + description: Get a single A/B test by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /ab-tests/subject/{abTestId}/winner + method: chooseWinner + httpMethod: post + tag: A/B tests - subject + typeScriptTag: aBTestsSubject + description: Choose A/B test winner + parameters: + - name: variantId + schema: string + required: true + description: '' + example: VpKJdr + responses: + - statusCode: '204' + description: Choose A/B test winner + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /click-tracks/{clickTrackId} + method: getLinkDetailsById + httpMethod: get + tag: Click Tracks + typeScriptTag: clickTracks + description: Get click tracked link details by click track ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /newsletters/{newsletterId} + method: deleteNewsletter + httpMethod: delete + tag: Newsletters + typeScriptTag: newsletters + description: Delete newsletter + parameters: [] + responses: + - statusCode: '204' + description: Delete newsletter. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /newsletters/{newsletterId} + method: getSingleById + httpMethod: get + tag: Newsletters + typeScriptTag: newsletters + description: Get a single newsletter by its ID. + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /newsletters/{newsletterId}/activities + method: getActivities + httpMethod: get + tag: Newsletters + typeScriptTag: newsletters + description: Get newsletter activities + parameters: + - name: query[activity] + schema: string + required: false + description: Search newsletter activities by activity type + - name: query[createdOn][from] + schema: undefined + required: false + description: >- + Search newsletter activities from this date. Default value is 14 days + earlier. You can get activities for last 30 days only. + - name: query[createdOn][to] + schema: undefined + required: false + description: Search newsletter activities to this date. Default value is now + - name: sort[createdOn] + schema: string + required: false + description: Sort by date + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /newsletters/{newsletterId}/cancel + method: cancelSending + httpMethod: post + tag: Newsletters + typeScriptTag: newsletters + description: Cancel sending the newsletter + parameters: [] + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /newsletters/{newsletterId}/thumbnail + method: getThumbnail + httpMethod: get + tag: Newsletters + typeScriptTag: newsletters + description: Get newsletter thumbnail + parameters: + - name: size + schema: string + required: false + description: The size of the thumbnail + default: default + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /newsletters/{newsletterId}/statistics + method: getStatistics + httpMethod: get + tag: Newsletters + typeScriptTag: newsletters + description: The statistics of single newsletter + parameters: + - name: query[groupBy] + schema: string + required: false + description: Group results by time interval + - name: query[createdOn][from] + schema: undefined + required: false + description: Count data from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Count data to this date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /tags/{tagId} + method: deleteById + httpMethod: delete + tag: Tags + typeScriptTag: tags + description: Delete tag by ID + parameters: [] + responses: + - statusCode: '204' + description: Tag deleted successfully. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /tags/{tagId} + method: getById + httpMethod: get + tag: Tags + typeScriptTag: tags + description: Get tag by ID + parameters: + - name: tagId + schema: string + required: true + description: The tag ID + example: TAGID + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /tags/{tagId} + method: updateById + httpMethod: post + tag: Tags + typeScriptTag: tags + description: Update tag by ID + parameters: + - name: name + schema: string + description: '' + example: My_Tag + - name: color + schema: string + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /addresses/{addressId} + method: deleteAddress + httpMethod: delete + tag: Addresses + typeScriptTag: addresses + description: Delete address + parameters: [] + responses: + - statusCode: '204' + description: Empty response + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /addresses/{addressId} + method: getAddressById + httpMethod: get + tag: Addresses + typeScriptTag: addresses + description: Get an address by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /addresses/{addressId} + method: updateAddress + httpMethod: post + tag: Addresses + typeScriptTag: addresses + description: Update address + parameters: + - name: createdOn + schema: string + description: '' + - name: updatedOn + schema: string + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /campaigns/{campaignId}/blocklists + method: getBlocklistMasks + httpMethod: get + tag: Campaigns (https://apireference.getresponse.com/ + typeScriptTag: campaignsHttps:ApireferenceGetresponseCom + description: Returns campaign blocklist masks + parameters: + - name: query[mask] + schema: string + required: false + description: Blocklist mask to search for + example: '@somedomain.com' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /campaigns/{campaignId}/blocklists + method: updateBlocklistMasks + httpMethod: post + tag: Campaigns (https://apireference.getresponse.com/ + typeScriptTag: campaignsHttps:ApireferenceGetresponseCom + description: Updates campaign blocklist masks + parameters: + - name: additionalFlags + schema: string + required: false + description: >- + The flag value `add` adds the masks provided in the request body to + your blocklist. The flag value `delete` deletes the masks. The masks + are replaced if there are no flag values in the request body. + + For better performance, use the flag value `noResponse`. It removes the response body and can be used alone or combined with other flags. If multiple flags are used, separate them by a comma, like this: `additionalFlags=noResponse` or `additionalFlags=add,noResponse`. + - name: masks + schema: array + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /custom-fields/{customFieldId} + method: deleteSingleCustomField + httpMethod: delete + tag: Custom Fields + typeScriptTag: customFields + description: Delete a single custom field definition + parameters: [] + responses: + - statusCode: '204' + description: Delete a custom field. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /custom-fields/{customFieldId} + method: getDefinitionById + httpMethod: get + tag: Custom Fields + typeScriptTag: customFields + description: Get a single custom field definition by the custom field ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /custom-fields/{customFieldId} + method: updateDefinition + httpMethod: post + tag: Custom Fields + typeScriptTag: customFields + description: Update the custom field definition + parameters: + - name: hidden + schema: string + required: true + description: '' + example: HIDDEN + - name: values + schema: array + required: true + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /lps/{lpsId} + method: getById + httpMethod: get + tag: Landing Pages + typeScriptTag: landingPages + description: Get a single landing page by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /statistics/lps/{lpsId}/performance + method: getPerformanceDetails + httpMethod: get + tag: Landing Page + typeScriptTag: landingPage + description: Get details for landing page statistics + parameters: + - name: query[date][from] + schema: undefined + required: false + description: Show a single landing page statistics from this date + - name: query[date][to] + schema: undefined + required: false + description: Show a single landing page statistics to this date + - name: query[location] + schema: string + required: false + description: Landing page statistics by location + - name: query[device] + schema: string + required: false + description: Landing page statistics by device + - name: query[page] + schema: string + required: false + description: Landing page statistics by page UUID + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/products/{productId}/variants + method: getProductVariantsList + httpMethod: get + tag: Product Variants + typeScriptTag: productVariants + description: Get a list of product variants + parameters: + - name: query[name] + schema: string + required: false + description: Search variant by name + - name: query[sku] + schema: string + required: false + description: Search variant by SKU + - name: query[description] + schema: string + required: false + description: Search variant by description + - name: query[externalId] + schema: string + required: false + description: Search variant by external ID + - name: query[createdAt][from] + schema: string + required: false + description: Show variants starting from this date + - name: query[createdAt][to] + schema: string + required: false + description: Show variants starting to this date + - name: sort[createdOn] + schema: string + required: false + description: Sort by date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/products/{productId}/variants + method: createNewVariant + httpMethod: post + tag: Product Variants + typeScriptTag: productVariants + description: Create product variant + parameters: + - name: description + schema: string + description: '' + example: Red Cap with GetResponse Monster print + - name: variantId + schema: string + description: '' + example: VTB + - name: href + schema: string + description: '' + example: https://api.getresponse.com/v3/shops/pf3/products/9I/variants/VTB + - name: name + schema: string + description: '' + example: Red Monster Cap + - name: url + schema: string + description: '' + example: https://somedomain.com/products-variants/986 + - name: sku + schema: string + description: '' + example: SKU-1254-56-457-5689 + - name: price + schema: number + description: '' + example: 20 + - name: priceTax + schema: number + description: '' + example: 27.5 + - name: previousPrice + schema: number + description: '' + example: 25 + - name: previousPriceTax + schema: number + description: '' + example: 33.6 + - name: quantity + schema: integer + description: '' + default: 1 + - name: position + schema: integer + description: '' + example: 1 + - name: barcode + schema: string + description: '' + example: '12455687' + - name: externalId + schema: string + description: '' + example: ext1456 + - name: images + schema: array + description: '' + - name: metaFields + schema: array + description: '' + - name: taxes + schema: array + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/products/{productId}/variants/{variantId} + method: deleteVariant + httpMethod: delete + tag: Product Variants + typeScriptTag: productVariants + description: Delete product variant + parameters: [] + responses: + - statusCode: '204' + description: Delete product variant + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/products/{productId}/variants/{variantId} + method: getById + httpMethod: get + tag: Product Variants + typeScriptTag: productVariants + description: Get a single product variant by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/products/{productId}/variants/{variantId} + method: updateVariantProperties + httpMethod: post + tag: Product Variants + typeScriptTag: productVariants + description: Update product variant + parameters: [] + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /campaigns/{campaignId} + method: getSingleCampaign + httpMethod: get + tag: Campaigns (https://apireference.getresponse.com/ + typeScriptTag: campaignsHttps:ApireferenceGetresponseCom + description: Get a single campaign by the campaign ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /campaigns/{campaignId} + method: updateCampaign + httpMethod: post + tag: Campaigns (https://apireference.getresponse.com/ + typeScriptTag: campaignsHttps:ApireferenceGetresponseCom + description: Update a campaign + parameters: [] + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '409' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/meta-fields + method: getCollection + httpMethod: get + tag: Meta Fields + typeScriptTag: metaFields + description: Get the shop meta fields + parameters: + - name: query[name] + schema: string + required: false + description: Search meta fields by name + - name: query[description] + schema: string + required: false + description: Search meta fields by description + - name: query[value] + schema: string + required: false + description: Search meta fields by value + - name: query[createdOn][from] + schema: undefined + required: false + description: Search meta fields created from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Search meta fields created to this date + - name: sort[createdOn] + schema: string + required: false + description: Sort by date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/meta-fields + method: createNewMetaField + httpMethod: post + tag: Meta Fields + typeScriptTag: metaFields + description: Create meta field + parameters: + - name: description + schema: string + description: '' + example: Description of this meta field + - name: href + schema: string + description: '' + example: https://api.getresponse.com/v3/shops/pf3/meta-fields/NoF + - name: metaFieldId + schema: string + description: '' + example: NoF + - name: name + schema: string + description: '' + example: Shoe size + - name: value + schema: string + description: '' + example: '11' + - name: valueType + schema: string + description: '' + example: integer + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/meta-fields/{metaFieldId} + method: delete + httpMethod: delete + tag: Meta Fields + typeScriptTag: metaFields + description: Delete meta field + parameters: [] + responses: + - statusCode: '204' + description: Delete meta field + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/meta-fields/{metaFieldId} + method: getById + httpMethod: get + tag: Meta Fields + typeScriptTag: metaFields + description: Get the meta field by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /shops/{shopId}/meta-fields/{metaFieldId} + method: updateProperties + httpMethod: post + tag: Meta Fields + typeScriptTag: metaFields + description: Update meta field + parameters: [] + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /webforms/{webformId} + method: getById + httpMethod: get + tag: Legacy Forms + typeScriptTag: legacyForms + description: Get Legacy Form by ID. + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /gdpr-fields/{gdprFieldId} + method: getDetails + httpMethod: get + tag: GDPR Fields + typeScriptTag: gdprFields + description: Get GDPR Field details + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /workflow/{workflowId} + method: getById + httpMethod: get + tag: Workflows + typeScriptTag: workflows + description: Get workflow by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /workflow/{workflowId} + method: updateSingleWorkflow + httpMethod: post + tag: Workflows + typeScriptTag: workflows + description: Update workflow + parameters: + - name: status + schema: string + required: true + description: '' + example: active + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /sms/{smsId} + method: getById + httpMethod: get + tag: SMS Messages + typeScriptTag: smsMessages + description: Get a single SMS message by its ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /autoresponders/{autoresponderId} + method: deleteById + httpMethod: delete + tag: Autoresponders + typeScriptTag: autoresponders + description: Delete autoresponder. + parameters: [] + responses: + - statusCode: '204' + description: Delete autoresponder + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /autoresponders/{autoresponderId} + method: getById + httpMethod: get + tag: Autoresponders + typeScriptTag: autoresponders + description: Get a single autoresponder by its ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /autoresponders/{autoresponderId} + method: updateAutoresponder + httpMethod: post + tag: Autoresponders + typeScriptTag: autoresponders + description: Update autoresponder + parameters: + - name: autoresponderId + schema: string + required: true + description: '' + example: Q + - name: href + schema: string + required: true + description: '' + example: https://api.getresponse.com/v3/autoresponders/Q + - name: name + schema: string + required: false + description: '' + example: Message 2 + - name: subject + schema: string + required: false + description: '' + example: test12 + - name: campaignId + schema: string + required: false + description: '' + example: V + - name: status + schema: string + required: false + description: '' + - name: editor + schema: string + required: false + description: '' + - name: fromField + schema: object + required: false + description: '' + - name: replyTo + schema: object + required: false + description: '' + - name: content + schema: object + required: false + description: '' + - name: flags + schema: array + required: false + description: '' + - name: sendSettings + schema: object + required: false + description: '' + - name: triggerSettings + schema: object + required: false + description: '' + - name: statistics + schema: object + required: false + description: '' + - name: createdOn + schema: string + required: false + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '409' + description: '' + - statusCode: '429' + description: '' + - url: /autoresponders/{autoresponderId}/thumbnail + method: getThumbnail + httpMethod: get + tag: Autoresponders + typeScriptTag: autoresponders + description: Get the autoresponder thumbnail + parameters: + - name: size + schema: string + required: false + description: The size of the autoresponder thumbnail + default: default + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /autoresponders/{autoresponderId}/statistics + method: getStatistics + httpMethod: get + tag: Autoresponders + typeScriptTag: autoresponders + description: The statistics for a single autoresponder + parameters: + - name: query[groupBy] + schema: string + required: false + description: Group results by time interval + - name: query[createdOn][from] + schema: undefined + required: false + description: Count data from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Count data to this date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /websites/{websiteId} + method: getById + httpMethod: get + tag: Websites + typeScriptTag: websites + description: Get a single Website by ID + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /statistics/wbe/{websiteId}/performance + method: getPerformanceDetails + httpMethod: get + tag: Website + typeScriptTag: website + description: Get details for website statistics + parameters: + - name: query[date][from] + schema: undefined + required: false + description: Show a single website statistics from this date + - name: query[date][to] + schema: undefined + required: false + description: Show a single website statistics to this date + - name: query[location] + schema: string + required: false + description: Website statistics by location + - name: query[device] + schema: string + required: false + description: Website statistics by device + - name: query[page] + schema: string + required: false + description: Website statistics by a page UUID + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /webinars + method: getList + httpMethod: get + tag: Webinars + typeScriptTag: webinars + description: Get a list of webinars + parameters: + - name: query[name] + schema: string + required: false + description: Search webinars by name + - name: query[campaignId] + schema: string + required: false + description: The list of campaign resource IDs (string separated with ',') + - name: query[status] + schema: string + required: false + description: Search webinars by status + - name: sort[name] + schema: string + required: false + description: Sort webinars by name + - name: sort[createdOn] + schema: string + required: false + description: Sort webinars by creation date + - name: sort[startsOn] + schema: string + required: false + description: Sort webinars by update date + - name: query[type] + schema: string + required: false + description: Search webinars by type + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /contacts + method: getList + httpMethod: get + tag: Contacts + typeScriptTag: contacts + description: Get contact list + parameters: + - name: query[email] + schema: string + required: false + description: Search contacts by email + - name: query[name] + schema: string + required: false + description: Search contacts by name + - name: query[campaignId] + schema: string + required: false + description: Search contacts by campaign ID + - name: query[origin] + schema: string + required: false + description: Search contacts by origin + - name: query[createdOn][from] + schema: undefined + required: false + description: Count data from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Count data to this date + - name: query[changedOn][from] + schema: undefined + required: false + description: Search contacts edited from this date + - name: query[changedOn][to] + schema: undefined + required: false + description: Search contacts edited to this date + - name: sort[email] + schema: string + required: false + description: Sort by email + - name: sort[name] + schema: string + required: false + description: Sort by name + - name: sort[createdOn] + schema: string + required: false + description: Sort by date + - name: sort[changedOn] + schema: string + required: false + description: Sort by change date + - name: sort[campaignId] + schema: string + required: false + description: Sort by campaign ID + - name: additionalFlags + schema: string + required: false + description: >- + The additional flags parameter with the value 'exactMatch' will search + for contacts with the exact value of the email and name provided in + the query string. Without this flag, matching is done via a standard + 'like' comparison, which may sometimes be slow. + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /contacts + method: createNewContact + httpMethod: post + tag: Contacts + typeScriptTag: contacts + description: Create a new contact + parameters: [] + responses: + - statusCode: '202' + description: >- + > + + If the request is successful, the API returns the HTTP code **202 + Accepted**. + + This means that the contact has been preliminarily validated and added + to the queue. + + It may take a few minutes to process the queue and add the contact to + the list. If your contact didn't appear on the list, there's a + possibility that it was rejected at a later stage of processing. + + + ### Double opt-in + + + Campaigns can be set to double opt-in. + + This means that the contact has to click a link in a confirmation + message before they can be added to your list. + + Unconfirmed contacts are not returned by the API and can only be found + using Search Contacts. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '409' + description: '' + - statusCode: '429' + description: '' + - url: /contacts/batch + method: createBatchContacts + httpMethod: post + tag: Contacts + typeScriptTag: contacts + description: Create multiple contacts at once + parameters: + - name: campaignId + schema: string + required: true + description: '' + example: C + - name: contacts + schema: array + required: true + description: '' + responses: + - statusCode: '202' + description: >- + > + + If the request is successful, the API returns the HTTP code **202 + Accepted**. + + This means that the contacts has been preliminarily validated and + added to the queue. + + It may take a few minutes to process the queue and add the contacts to + the list. If your contact doesn't appear on the list, they were likely + rejected during the late processing stages. + + + ### Double opt-in + + + Campaigns (https://apireference.getresponse.com/ can be set to use + double opt-in. + + This means that a contact has to click a link in a confirmation + message before they can be added to your list. + + Unconfirmed contacts are not returned by API and can only be found + using Search Contacts. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '409' + description: '' + - statusCode: '429' + description: '' + - url: /search-contacts + method: savedList + httpMethod: get + tag: Search Contacts + typeScriptTag: searchContacts + description: Get a saved search contact list + parameters: + - name: sort[name] + schema: string + required: false + description: Sort by name + example: desc + - name: sort[createdOn] + schema: string + required: false + description: Sort by creation date + example: asc + - name: query[name] + schema: string + required: false + description: Search by name + - name: query[createdOn][from] + schema: undefined + required: false + description: Count data from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Count data to this date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /search-contacts + method: createNewSearch + httpMethod: post + tag: Search Contacts + typeScriptTag: searchContacts + description: Create search contacts + parameters: [] + responses: + - statusCode: '201' + description: Search contact details. + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '409' + description: '' + - statusCode: '429' + description: '' + - url: /search-contacts/contacts + method: usingConditions + httpMethod: post + tag: Search Contacts + typeScriptTag: searchContacts + description: Search contacts using conditions + parameters: + - name: sort[name] + schema: string + required: false + description: Sort by name + example: desc + - name: sort[email] + schema: string + required: false + description: Sort by email + example: desc + - name: sort[createdOn] + schema: string + required: false + description: Sort by creation date + example: asc + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + - name: subscribersType + schema: array + required: true + description: '' + - name: sectionLogicOperator + schema: string + required: true + description: '' + example: or + - name: section + schema: array + required: true + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /transactional-emails/templates + method: getList + httpMethod: get + tag: Transactional Emails Templates + typeScriptTag: transactionalEmailsTemplates + description: Get the list of transactional email templates + parameters: + - name: query[subject] + schema: string + required: false + description: Search templates by subject + - name: sort[createdOn] + schema: string + required: false + description: Sort by creation date + - name: sort[subject] + schema: string + required: false + description: Sort by template subject + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /transactional-emails/templates + method: createNewTemplate + httpMethod: post + tag: Transactional Emails Templates + typeScriptTag: transactionalEmailsTemplates + description: Create transactional email template + parameters: + - name: subject + schema: string + required: true + description: '' + example: Order Confirmation - Example Shop + - name: content + schema: object + required: false + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /transactional-emails + method: getList + httpMethod: get + tag: Transactional Emails + typeScriptTag: transactionalEmails + description: Get the list of transactional emails + parameters: + - name: query[sentOn][from] + schema: undefined + required: false + description: Search transactional emails sent from this date + - name: query[sentOn][to] + schema: undefined + required: false + description: Search transactional emails sent to this date + - name: query[tagged] + schema: string + required: false + description: Search tagged/untagged transactional emails + - name: query[tagId] + schema: string + required: false + description: Search transactional emails with a specific tag ID + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /transactional-emails + method: sendEmail + httpMethod: post + tag: Transactional Emails + typeScriptTag: transactionalEmails + description: Send transactional email + parameters: + - name: fromField + schema: object + required: true + description: '' + - name: replyTo + schema: object + required: false + description: '' + - name: tag + schema: object + required: false + description: '' + - name: recipients + schema: object + required: true + description: '' + - name: contentType + schema: string + required: true + description: '' + example: CONTENTTYPE + default: direct + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /transactional-emails/statistics + method: getOverallStatistics + httpMethod: get + tag: Transactional Emails + typeScriptTag: transactionalEmails + description: Get the overall statistics of transactional emails + parameters: + - name: query[groupBy] + schema: string + required: true + description: Group results by time interval + example: QUERY[GROUPBY] + - name: query[timeFrame][from] + schema: undefined + required: false + description: Count data from this date + - name: query[timeFrame][to] + schema: undefined + required: false + description: Count data to this date + - name: query[tagged] + schema: string + required: false + description: Search tagged/untagged transactional emails + - name: query[tagId] + schema: string + required: false + description: Search transactional emails with a specific tag ID + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /from-fields + method: getList + httpMethod: get + tag: From Fields + typeScriptTag: fromFields + description: Get the list of 'From' addresses + parameters: + - name: query[email] + schema: string + required: false + description: Search 'From' address by email + - name: query[name] + schema: string + required: false + description: Search 'From' address by name + - name: query[isDefault] + schema: boolean + required: false + description: Search only default 'From' address + example: true + - name: query[isActive] + schema: boolean + required: false + description: Search only active 'From' addresses + example: true + - name: sort[createdOn] + schema: string + required: false + description: Sort 'From' address by date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /from-fields + method: createNewAddress + httpMethod: post + tag: From Fields + typeScriptTag: fromFields + description: Create 'From' address + parameters: + - name: fromFieldId + schema: string + description: '' + example: TTzW + - name: href + schema: string + description: '' + example: https://api.getresponse.com/v3/from-fields/TTzW + - name: email + schema: string + description: '' + example: jsmith@example.com + - name: rewrittenEmail + schema: string + description: '' + example: jsmith@example.com + - name: name + schema: string + description: '' + example: John Smith + - name: isActive + schema: string + description: '' + - name: isDefault + schema: string + description: '' + - name: createdOn + schema: string + description: '' + - name: domain + schema: object + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '409' + description: '' + - statusCode: '429' + description: '' + - url: /rss-newsletters + method: getList + httpMethod: get + tag: RSS Newsletters + typeScriptTag: rssNewsletters + description: Get the list of RSS newsletters + parameters: + - name: query[subject] + schema: string + required: false + description: Search RSS newsletters by subject + - name: query[status] + schema: string + required: false + description: Search RSS newsletters by status + - name: query[createdOn][from] + schema: undefined + required: false + description: Search RSS newsletters created from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Search RSS newsletters created to this date + - name: query[campaignId] + schema: string + required: false + description: Search RSS newsletters by campaign ID + - name: sort[createdOn] + schema: string + required: false + description: Sort by date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /rss-newsletters + method: createNewsletter + httpMethod: post + tag: RSS Newsletters + typeScriptTag: rssNewsletters + description: Create RSS newsletter + parameters: + - name: rssNewsletterId + schema: string + required: true + description: '' + example: dGer + - name: href + schema: string + required: true + description: '' + example: https://api.getresponse.com/v3/rss-newsletters/dGer + - name: rssFeedUrl + schema: string + required: false + description: '' + example: http://blog.getresponse.com + - name: subject + schema: string + required: false + description: '' + example: My rss to newsletters + - name: name + schema: string + required: false + description: '' + example: rsstest0 + - name: status + schema: string + required: false + description: '' + - name: editor + schema: string + required: false + description: '' + - name: fromField + schema: object + required: false + description: '' + - name: replyTo + schema: object + required: false + description: '' + - name: content + schema: object + required: false + description: '' + - name: sendSettings + schema: object + required: false + description: '' + - name: createdOn + schema: string + required: false + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /rss-newsletters/statistics + method: getStatistics + httpMethod: get + tag: RSS Newsletters + typeScriptTag: rssNewsletters + description: The statistics for all RSS newsletters + parameters: + - name: query[groupBy] + schema: string + required: false + description: Group results by time interval + - name: query[rssNewsletterId] + schema: string + required: false + description: The list of RSS newsletter resource IDs (string separated with ',') + - name: query[campaignId] + schema: string + required: false + description: The list of campaign resource IDs (string separated with ',') + - name: query[createdOn][from] + schema: undefined + required: false + description: Count data from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Count data to this date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /custom-events + method: getList + httpMethod: get + tag: Custom Events + typeScriptTag: customEvents + description: Get a list of custom events + parameters: + - name: query[name] + schema: string + required: false + description: Search custom events by name + - name: query[hasAttributes] + schema: string + required: false + description: Search custom events with or without attributes + - name: sort[name] + schema: string + required: false + description: Sort by name + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /custom-events + method: createEvent + httpMethod: post + tag: Custom Events + typeScriptTag: customEvents + description: Create custom event + parameters: + - name: name + schema: string + required: true + description: '' + example: sample_custom_event + - name: attributes + schema: array + required: true + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /custom-events/trigger + method: triggerEvent + httpMethod: post + tag: Custom Events + typeScriptTag: customEvents + description: Trigger a custom event + parameters: + - name: name + schema: string + required: true + description: '' + example: lesson_finished + - name: contactId + schema: string + required: true + description: '' + example: lTgH5 + - name: attributes + schema: array + required: false + description: '' + responses: + - statusCode: '201' + description: Empty response + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /forms + method: getList + httpMethod: get + tag: Forms + typeScriptTag: forms + description: Get the list of forms. + parameters: + - name: query[name] + schema: string + required: false + description: Search forms by name + - name: query[createdOn][from] + schema: undefined + required: false + description: Search forms created from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Search forms created to this date + - name: query[campaignId] + schema: string + required: false + description: >- + Search forms assigned to this list + (https://apireference.getresponse.com/. You can pass multiple + comma-separated values, eg. `Xd1P,sC7r` + - name: query[status] + schema: string + required: false + description: >- + Search by status. **Note:** `disabled` includes both `unpublished` and + `draft` and `enabled` equals `published` + - name: sort[createdOn] + schema: string + required: false + description: '' + - name: sort[name] + schema: string + required: false + description: '' + - name: sort[visitors] + schema: string + required: false + description: '' + - name: sort[uniqueVisitors] + schema: string + required: false + description: '' + - name: sort[subscribed] + schema: string + required: false + description: '' + - name: sort[subscriptionRate] + schema: string + required: false + description: '' + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /landing-pages + method: getList + httpMethod: get + tag: Legacy Landing Pages + typeScriptTag: legacyLandingPages + description: Get a list of landing pages + parameters: + - name: query[domain] + schema: string + required: false + description: Search landing pages by domain + - name: query[status] + schema: string + required: false + description: Search landing pages by status + - name: query[subdomain] + schema: string + required: false + description: Search landing pages by subdomain + - name: query[metaTitle] + schema: string + required: false + description: Search landing pages by metaTitle field + - name: query[userDomain] + schema: string + required: false + description: Search landing pages by user provided domain + - name: query[campaignId] + schema: string + required: false + description: >- + Search landing pages by ID of the assigned campaign. Campaign ID must + be encoded! You can get the campaign list with encoded IDs by calling + the `/v3/campaigns` endpoint. You can search by multiple comma + separated values eg. `o5lx,34er`. + - name: query[createdOn][from] + schema: undefined + required: false + description: Show landing pages created from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Show landing pages created to this date + - name: sort[createdOn] + schema: string + required: false + description: Sort by date + - name: sort[domain] + schema: string + required: false + description: Sort by domain + - name: sort[campaignId] + schema: string + required: false + description: Sort by campaign + - name: sort[metaTitle] + schema: string + required: false + description: Sort by metaTitle + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /imports + method: getList + httpMethod: get + tag: Imports + typeScriptTag: imports + description: Get a list of imports. + parameters: + - name: query[campaignId] + schema: string + required: false + description: Search imports by campaignId + - name: query[createdOn][from] + schema: undefined + required: false + description: Search imports created from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Search imports created to this date + - name: sort[createdOn] + schema: string + required: false + description: Sort imports by creation date + - name: sort[finishedOn] + schema: string + required: false + description: Sort imports by finish date + - name: sort[campaignName] + schema: string + required: false + description: Sort imports by campaign name + - name: sort[uploadedContacts] + schema: string + required: false + description: Sort imports by uploaded contact count + - name: sort[updatedContacts] + schema: string + required: false + description: Sort imports by updated contact count + - name: sort[addedContacts] + schema: string + required: false + description: Sort imports by inserted contact count + - name: sort[invalidContacts] + schema: string + required: false + description: Sort imports by invalid contact count + - name: sort[status] + schema: string + required: false + description: >- + Sort imports by status (uploaded, to_review, approved, finished, + rejected, canceled) + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /imports + method: scheduleNewContactImport + httpMethod: post + tag: Imports + typeScriptTag: imports + description: Schedule a new contact import + parameters: + - name: campaignId + schema: string + required: true + description: '' + example: z5c + - name: fieldMapping + schema: array + required: true + description: '' + - name: contacts + schema: array + required: true + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '409' + description: '' + - statusCode: '429' + description: '' + - url: /statistics/ecommerce/revenue + method: getRevenueStatistics + httpMethod: get + tag: Ecommerce + typeScriptTag: ecommerce + description: Get the ecommerce revenue statistics + parameters: + - name: query[orderDate][from] + schema: string + required: false + description: Show statistics for orders from this date + - name: query[orderDate][to] + schema: string + required: false + description: Show statistics for orders to this date + - name: query[shopId] + schema: string + required: false + description: >- + Search statistics by shop ID. You can get the shop ID by calling the + `/v3/shops` endpoint. You can search for multiple shops using + comma-separated values, for example, `pgIH, CNXF` + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /statistics/ecommerce/performance + method: getPerformanceStatistics + httpMethod: get + tag: Ecommerce + typeScriptTag: ecommerce + description: Get the ecommerce general performance statistics + parameters: + - name: query[orderDate][from] + schema: string + required: false + description: Show statistics for orders from this date + - name: query[orderDate][to] + schema: string + required: false + description: Show statistics for orders to this date + - name: query[shopId] + schema: string + required: false + description: >- + Search statistics by shop ID. You can get the shop ID by calling the + `/v3/shops` endpoint. You can search for multiple shops using + comma-separated values, for example, `pgIH, CNXF` + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /predefined-fields + method: getList + httpMethod: get + tag: Predefined Fields + typeScriptTag: predefinedFields + description: Get the predefined fields list + parameters: + - name: sort[name] + schema: string + required: false + description: Sort by name + example: DESC + - name: query[name] + schema: string + required: false + description: Search by name + - name: query[campaignId] + schema: string + required: false + description: Search by campaign ID + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /predefined-fields + method: createField + httpMethod: post + tag: Predefined Fields + typeScriptTag: predefinedFields + description: Create a predefined field + parameters: + - name: predefinedFieldId + schema: string + description: '' + example: 6neM + - name: href + schema: string + description: '' + example: https://api.getresponse.com/v3/predefined-fields/6neM + - name: name + schema: string + description: '' + example: my_predefined_field_123 + - name: value + schema: string + description: '' + example: my value + - name: campaign + schema: object + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '409' + description: '' + - statusCode: '429' + description: '' + - url: /suppressions + method: getSuppressionLists + httpMethod: get + tag: Suppressions + typeScriptTag: suppressions + description: Get suppression lists + parameters: + - name: query[name] + schema: string + required: false + description: Search suppressions by name + - name: query[createdOn][from] + schema: undefined + required: false + description: Search suppressions created from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Search suppressions created to this date + - name: sort[name] + schema: string + required: false + description: Sort by name + - name: sort[createdOn] + schema: string + required: false + description: Sort by the createdOn date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /suppressions + method: createNewSuppressionList + httpMethod: post + tag: Suppressions + typeScriptTag: suppressions + description: Creates a new suppression list + parameters: + - name: name + schema: string + description: '' + example: suppression-name + - name: masks + schema: array + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '409' + description: '' + - statusCode: '429' + description: '' + - url: /subscription-confirmations/body/{languageCode} + method: getCollectionOfBodies + httpMethod: get + tag: Subscription Confirmations + typeScriptTag: subscriptionConfirmations + description: Get collection of SUBSCRIPTION CONFIRMATIONS bodies + parameters: + - name: languageCode + schema: string + required: true + description: ISO 639-1 Language Code Standard + example: en + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /subscription-confirmations/subject/{languageCode} + method: getSubjectCollection + httpMethod: get + tag: Subscription Confirmations + typeScriptTag: subscriptionConfirmations + description: Get collection of SUBSCRIPTION CONFIRMATIONS subjects + parameters: + - name: languageCode + schema: string + required: true + description: ISO 639-1 Language Code Standard + example: en + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /shops + method: getListOfShops + httpMethod: get + tag: Shops + typeScriptTag: shops + description: Get a list of shops + parameters: + - name: query[name] + schema: string + required: false + description: Search shop by name + - name: sort[name] + schema: string + required: false + description: Sort by name + - name: sort[createdOn] + schema: string + required: false + description: Sort by date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /shops + method: createNewShop + httpMethod: post + tag: Shops + typeScriptTag: shops + description: Create shop + parameters: + - name: createdOn + schema: string + description: '' + - name: updatedOn + schema: string + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /popups + method: getList + httpMethod: get + tag: Forms and Popups + typeScriptTag: formsAndPopups + description: Get the list of forms and popups + parameters: + - name: query[name] + schema: string + required: false + description: Search forms and popups by name + - name: query[status] + schema: string + required: false + description: Search forms and popups by status + - name: stats[from] + schema: string + required: false + description: Show statistics from this date + - name: stats[to] + schema: string + required: false + description: Show statistics to this date + - name: sort[name] + schema: string + required: false + description: Sort forms and popups by name + - name: sort[status] + schema: string + required: false + description: Sort forms and popups by status + - name: sort[createdAt] + schema: string + required: false + description: Sort forms and popups by creation date + - name: sort[updatedAt] + schema: string + required: false + description: Sort forms and popups by modification date + - name: sort[views] + schema: string + required: false + description: Sort by number of views + - name: sort[uniqueVisitors] + schema: string + required: false + description: Sort by number of unique visitors + - name: sort[leads] + schema: string + required: false + description: Sort by number of leads + - name: sort[ctr] + schema: string + required: false + description: Sort by CTR (click-through rate) + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /splittests + method: getList + httpMethod: get + tag: A/B tests + typeScriptTag: aBTests + description: The list of A/B tests. + parameters: + - name: query[name] + schema: string + required: false + description: Search A/B tests by name + - name: query[type] + schema: string + required: false + description: Search A/B tests by type + - name: query[status] + schema: string + required: false + description: Search A/B tests by status + default: active + - name: query[createdOn][from] + schema: undefined + required: false + description: Search A/B tests created from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Search A/B tests created to this date + - name: sort[name] + schema: string + required: false + description: Sort by name + - name: sort[createdOn] + schema: string + required: false + description: Sort by creation date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /file-library/quota + method: getStorageInfo + httpMethod: get + tag: File Library + typeScriptTag: fileLibrary + description: Get storage space information + parameters: [] + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /file-library/files + method: getFileList + httpMethod: get + tag: File Library + typeScriptTag: fileLibrary + description: Get the list of files + parameters: + - name: query[allFolders] + schema: string + required: false + description: >- + Return files from all folders, including the root folder. **This + parameter can't be used together with ** `query[folderId]` + - name: query[folderId] + schema: string + required: false + description: >- + Search for files in a specific folder. **This parameter can't be used + together with ** `query[allFolders]` + - name: query[name] + schema: string + required: false + description: Search for files by name + - name: query[group] + schema: string + required: false + description: Search for files by group + example: photo + - name: sort[name] + schema: string + required: false + description: Sort by name + - name: sort[group] + schema: string + required: false + description: Sort files by group + - name: sort[size] + schema: string + required: false + description: Sort files by size + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /file-library/files + method: createNewFile + httpMethod: post + tag: File Library + typeScriptTag: fileLibrary + description: Create a file + parameters: + - name: name + schema: string + description: '' + example: image + - name: extension + schema: string + description: '' + example: jpg + - name: folder + schema: undefined + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /file-library/folders + method: listFolders + httpMethod: get + tag: File Library + typeScriptTag: fileLibrary + description: Get the list of folders + parameters: + - name: query[name] + schema: string + required: false + description: Search folders by name + - name: sort[name] + schema: string + required: false + description: Sort folders by name + - name: sort[size] + schema: string + required: false + description: Sort folders by size + - name: sort[createdOn] + schema: string + required: false + description: Sort folders by creation date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /file-library/folders + method: createFolder + httpMethod: post + tag: File Library + typeScriptTag: fileLibrary + description: Create a folder + parameters: + - name: name + schema: string + required: true + description: '' + example: sample folder + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '409' + description: '' + - statusCode: '429' + description: '' + - url: /ab-tests/subject + method: getList + httpMethod: get + tag: A/B tests - subject + typeScriptTag: aBTestsSubject + description: The list of A/B tests + parameters: + - name: query[name] + schema: string + required: false + description: Search A/B tests by name + - name: query[stage] + schema: string + required: false + description: Search A/B tests by stage + - name: query[abTestId] + schema: string + required: false + description: Search A/B tests by ID + - name: query[campaignId] + schema: string + required: false + description: Search A/B tests by list ID + - name: sort[name] + schema: string + required: false + description: Sort by name + - name: sort[stage] + schema: string + required: false + description: Sort by stage + - name: sort[sendOn] + schema: string + required: false + description: Sort by send date + - name: sort[totalDelivered] + schema: string + required: false + description: Sort by total delivered + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /ab-tests/subject + method: createNewTest + httpMethod: post + tag: A/B tests - subject + typeScriptTag: aBTestsSubject + description: Create a new A/B test + parameters: [] + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /click-tracks + method: getList + httpMethod: get + tag: Click Tracks + typeScriptTag: clickTracks + description: Get click tracked links list + parameters: + - name: query[createdOn][from] + schema: undefined + required: false + description: Search click tracks from messages created from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Search click tracks from messages created to this date + - name: sort[createdOn] + schema: string + required: false + description: Sort by message date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /newsletters + method: getList + httpMethod: get + tag: Newsletters + typeScriptTag: newsletters + description: Get the newsletter list + parameters: + - name: query[subject] + schema: string + required: false + description: Search newsletters by subject + - name: query[name] + schema: string + required: false + description: Search newsletters by name + - name: query[status] + schema: string + required: false + description: Search newsletters by status + - name: query[createdOn][from] + schema: undefined + required: false + description: Search newsletters created from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Search newsletters created to this date + - name: query[sendOn][from] + schema: string + required: false + description: Search for newsletters sent from this date + example: '2023-01-20' + - name: query[sendOn][to] + schema: string + required: false + description: Search for newsletters sent to this date + example: '2023-01-20' + - name: query[type] + schema: string + required: false + description: Search newsletters by type + - name: query[campaignId] + schema: string + required: false + description: Search newsletters by campaign ID + - name: sort[createdOn] + schema: string + required: false + description: Sort by date + - name: sort[sendOn] + schema: string + required: false + description: Sort by send on date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /newsletters + method: enqueueNewsletter + httpMethod: post + tag: Newsletters + typeScriptTag: newsletters + description: Create newsletter + parameters: + - name: content + schema: object + required: true + description: '' + - name: flags + schema: array + required: false + description: '' + - name: name + schema: string + required: false + description: '' + example: New message + - name: type + schema: string + required: false + description: '' + default: broadcast + - name: editor + schema: string + required: false + description: '' + - name: subject + schema: string + required: true + description: '' + example: Annual report + - name: fromField + schema: object + required: true + description: '' + - name: replyTo + schema: object + required: false + description: '' + - name: campaign + schema: object + required: true + description: '' + - name: sendOn + schema: string + required: false + description: '' + - name: attachments + schema: array + required: false + description: '' + - name: sendSettings + schema: object + required: true + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /newsletters/send-draft + method: sendDraft + httpMethod: post + tag: Newsletters + typeScriptTag: newsletters + description: Send the newsletter draft + parameters: + - name: messageId + schema: string + required: true + description: '' + example: 'N' + - name: sendOn + schema: string + required: false + description: '' + - name: sendSettings + schema: object + required: true + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /newsletters/statistics + method: getStatisticsBasedOnList + httpMethod: get + tag: Newsletters + typeScriptTag: newsletters + description: Total newsletter statistics + parameters: + - name: query[groupBy] + schema: string + required: false + description: Group results by time interval + - name: query[newsletterId] + schema: string + required: false + description: The list of newsletter resource IDs (string separated with '') + - name: query[campaignId] + schema: string + required: false + description: The list of campaign resource IDs (string separated with '') + - name: query[createdOn][from] + schema: undefined + required: false + description: Count data from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Count data to this date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /tags + method: getList + httpMethod: get + tag: Tags + typeScriptTag: tags + description: Get the list of tags + parameters: + - name: query[name] + schema: string + required: false + description: Search tags by name + - name: query[createdAt][from] + schema: undefined + required: false + description: Search tags created from this date + - name: query[createdAt][to] + schema: undefined + required: false + description: Search tags created to this date + - name: sort[createdAt] + schema: string + required: false + description: Sort tags by creation date + - name: sort[name] + schema: string + required: false + description: Sort by name + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /tags + method: addNewTag + httpMethod: post + tag: Tags + typeScriptTag: tags + description: Add a new tag + parameters: + - name: name + schema: string + description: '' + example: My_Tag + - name: color + schema: string + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /addresses + method: getList + httpMethod: get + tag: Addresses + typeScriptTag: addresses + description: Get a list of addresses + parameters: + - name: query[name] + schema: string + required: false + description: Search addresses by name + - name: query[firstName] + schema: string + required: false + description: Search addresses by first name + - name: query[lastName] + schema: string + required: false + description: Search addresses by last name + - name: query[address1] + schema: string + required: false + description: Search addresses by address1 field + - name: query[address2] + schema: string + required: false + description: Search addresses by address2 field + - name: query[city] + schema: string + required: false + description: Search addresses by city + - name: query[zip] + schema: string + required: false + description: Search addresses by ZIP + - name: query[province] + schema: string + required: false + description: Search addresses by province + - name: query[provinceCode] + schema: string + required: false + description: Search addresses by province code + - name: query[phone] + schema: string + required: false + description: Search addresses by phone + - name: query[company] + schema: string + required: false + description: Search addresses by company + - name: query[createdOn][from] + schema: string + required: false + description: Search addresses created from this date + - name: query[createdOn][to] + schema: string + required: false + description: Search addresses created to this date + - name: sort[createdOn] + schema: string + required: false + description: Sort by date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /addresses + method: createNewAddress + httpMethod: post + tag: Addresses + typeScriptTag: addresses + description: Create address + parameters: + - name: createdOn + schema: string + description: '' + - name: updatedOn + schema: string + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /accounts/blocklists + method: getBlocklistMasks + httpMethod: get + tag: Accounts + typeScriptTag: accounts + description: Returns account blocklist masks + parameters: + - name: query[mask] + schema: string + required: false + description: Blocklist mask to search for + example: '@somedomain.com' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /accounts/blocklists + method: updateBlocklist + httpMethod: post + tag: Accounts + typeScriptTag: accounts + description: Update account blocklist + parameters: + - name: additionalFlags + schema: string + required: false + description: >- + The flag value `add` adds the masks provided in the request body to + your blocklist. The flag value `delete` deletes the masks. The masks + are replaced if there are no flag values in the request body. + + For better performance, use the flag value `noResponse`. It removes the response body and can be used alone or combined with other flags. If multiple flags are used, separate them by a comma, like this: `additionalFlags=noResponse` or `additionalFlags=add,noResponse`. + - name: masks + schema: array + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /custom-fields + method: getList + httpMethod: get + tag: Custom Fields + typeScriptTag: customFields + description: Get a list of custom fields + parameters: + - name: query[name] + schema: string + required: false + description: Search custom fields by name + - name: sort[name] + schema: string + required: false + description: Sort by name + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /custom-fields + method: createNewField + httpMethod: post + tag: Custom Fields + typeScriptTag: customFields + description: Create a custom field + parameters: + - name: customFieldId + schema: string + description: '' + example: pas + - name: href + schema: string + description: '' + example: https://api.getresponse.com/v3/custom-fields/pas + - name: name + schema: string + description: '' + example: office_phone_number + - name: type + schema: string + description: '' + - name: valueType + schema: string + description: '' + example: phone + - name: format + schema: string + description: '' + - name: fieldType + schema: string + description: '' + example: text + - name: hidden + schema: string + description: '' + - name: values + schema: array + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /lps + method: getList + httpMethod: get + tag: Landing Pages + typeScriptTag: landingPages + description: Get the list of landing pages + parameters: + - name: query[name] + schema: string + required: false + description: Search landing pages by name + - name: query[status] + schema: string + required: false + description: Search landing pages by status + - name: stats[from] + schema: string + required: false + description: Show statistics for landing pages from this date + - name: stats[to] + schema: string + required: false + description: Show statistics for landing pages to this date + - name: sort[name] + schema: string + required: false + description: Sort landing pages by name + - name: sort[createdAt] + schema: string + required: false + description: Sort landing pages by creation date + - name: sort[updatedAt] + schema: string + required: false + description: Sort landing pages by modification date + - name: sort[visits] + schema: string + required: false + description: Sort by number of page visits + - name: sort[leads] + schema: string + required: false + description: Sort landing pages by number of leads + - name: sort[subscriptionRate] + schema: string + required: false + description: Sort by subscription rate + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /multimedia + method: getImageList + httpMethod: get + tag: Multimedia + typeScriptTag: multimedia + description: Get images list + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /multimedia + method: uploadImage + httpMethod: post + tag: Multimedia + typeScriptTag: multimedia + description: Upload image + parameters: + - name: file + schema: string + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /tracking + method: javascriptCodeSnippets + httpMethod: get + tag: Tracking + typeScriptTag: tracking + description: Get Tracking JavaScript code snippets + parameters: [] + responses: + - statusCode: '200' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /tracking/facebook-pixels + method: getFacebookPixels + httpMethod: get + tag: Tracking + typeScriptTag: tracking + description: Get the list of "Facebook Pixels" + parameters: [] + responses: + - statusCode: '200' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /accounts + method: getInformation + httpMethod: get + tag: Accounts + typeScriptTag: accounts + description: Account information + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /accounts + method: updateAccountDetails + httpMethod: post + tag: Accounts + typeScriptTag: accounts + description: Update account + parameters: + - name: accountId + schema: string + description: '' + example: VfEy1 + - name: email + schema: string + description: '' + example: john.smith@test.com + - name: countryCode + schema: object + description: '' + - name: industryTag + schema: object + description: '' + - name: timeZone + schema: undefined + description: '' + - name: href + schema: string + description: '' + example: https://api.getresponse.com/v3/accounts + - name: firstName + schema: string + description: '' + example: John + - name: lastName + schema: string + description: '' + example: Smith + - name: companyName + schema: string + description: '' + example: MyBigCompany + - name: phone + schema: string + description: '' + example: '+00155555555' + - name: state + schema: string + description: '' + example: Oklahoma + - name: city + schema: string + description: '' + example: Alderson + - name: street + schema: string + description: '' + example: Sunset blv. + - name: zipCode + schema: string + description: '' + example: 81-611 + - name: numberOfEmployees + schema: string + description: '' + example: '500' + - name: timeFormat + schema: string + description: '' + example: 24h + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /accounts/billing + method: getBillingInformation + httpMethod: get + tag: Accounts + typeScriptTag: accounts + description: Billing information + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /accounts/login-history + method: getLoginHistory + httpMethod: get + tag: Accounts + typeScriptTag: accounts + description: History of logins + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /accounts/badge + method: getCurrentStatusOfBadge + httpMethod: get + tag: Accounts + typeScriptTag: accounts + description: Current status of your GetResponse badge + parameters: [] + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /accounts/badge + method: toggleBadgeStatus + httpMethod: post + tag: Accounts + typeScriptTag: accounts + description: Turn on/off the GetResponse Badge + parameters: + - name: status + schema: string + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /accounts/industries + method: listIndustryTags + httpMethod: get + tag: Accounts + typeScriptTag: accounts + description: List of Industry Tags + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /accounts/timezones + method: getTimezonesList + httpMethod: get + tag: Accounts + typeScriptTag: accounts + description: List of timezones + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /accounts/callbacks + method: disableCallbacks + httpMethod: delete + tag: Accounts + typeScriptTag: accounts + description: Disable callbacks + parameters: [] + responses: + - statusCode: '204' + description: Empty response + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /accounts/callbacks + method: getConfiguration + httpMethod: get + tag: Accounts + typeScriptTag: accounts + description: Get callbacks configuration + parameters: [] + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '404' + description: '' + - statusCode: '429' + description: '' + - url: /accounts/callbacks + method: enableCallbacksConfiguration + httpMethod: post + tag: Accounts + typeScriptTag: accounts + description: Enable or update callbacks configuration + parameters: + - name: url + schema: string + description: '' + example: https://example.com/callback + - name: actions + schema: object + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /accounts/sending-limits + method: getSendingLimits + httpMethod: get + tag: Accounts + typeScriptTag: accounts + description: Send limits + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /campaigns + method: getList + httpMethod: get + tag: Campaigns (https://apireference.getresponse.com/ + typeScriptTag: campaignsHttps:ApireferenceGetresponseCom + description: Get a list of campaigns + parameters: + - name: query[name] + schema: string + required: false + description: '' + example: campaign_name + - name: query[isDefault] + schema: boolean + required: false + description: '' + example: true + - name: sort[name] + schema: string + required: false + description: Sort by name + - name: sort[createdOn] + schema: string + required: false + description: Sort by date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /campaigns + method: createNewCampaign + httpMethod: post + tag: Campaigns (https://apireference.getresponse.com/ + typeScriptTag: campaignsHttps:ApireferenceGetresponseCom + description: Create a campaign + parameters: [] + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '409' + description: '' + - statusCode: '429' + description: '' + - url: /campaigns/statistics/origins + method: getSubscriberOriginStatistics + httpMethod: get + tag: Campaigns (https://apireference.getresponse.com/ + typeScriptTag: campaignsHttps:ApireferenceGetresponseCom + description: Get subscriber origin statistics + parameters: + - name: query[campaignId] + schema: string + required: true + description: '' + example: 3Va2e + - name: query[groupBy] + schema: string + required: false + description: '' + example: month + - name: query[createdOn][from] + schema: undefined + required: false + description: '' + - name: query[createdOn][to] + schema: undefined + required: false + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /campaigns/statistics/locations + method: getSubscriberLocationStatistics + httpMethod: get + tag: Campaigns (https://apireference.getresponse.com/ + typeScriptTag: campaignsHttps:ApireferenceGetresponseCom + description: Get subscriber location statistics + parameters: + - name: query[campaignId] + schema: string + required: true + description: '' + example: 3Va2e + - name: query[groupBy] + schema: string + required: false + description: '' + example: month + - name: query[createdOn][from] + schema: undefined + required: false + description: '' + - name: query[createdOn][to] + schema: undefined + required: false + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /campaigns/statistics/list-size + method: getCampaignSizeStatistics + httpMethod: get + tag: Campaigns (https://apireference.getresponse.com/ + typeScriptTag: campaignsHttps:ApireferenceGetresponseCom + description: Get campaign size statistics + parameters: + - name: query[campaignId] + schema: string + required: true + description: '' + example: 3Va2e + - name: query[groupBy] + schema: string + required: false + description: '' + example: month + - name: query[createdOn][from] + schema: undefined + required: false + description: '' + - name: query[createdOn][to] + schema: undefined + required: false + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /campaigns/statistics/subscriptions + method: getSubscriptionStatistics + httpMethod: get + tag: Campaigns (https://apireference.getresponse.com/ + typeScriptTag: campaignsHttps:ApireferenceGetresponseCom + description: Get the number and origin of subscription statistics + parameters: + - name: query[campaignId] + schema: string + required: true + description: '' + example: 3Va2e + - name: query[groupBy] + schema: string + required: false + description: '' + example: month + - name: query[createdOn][from] + schema: undefined + required: false + description: '' + - name: query[createdOn][to] + schema: undefined + required: false + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /campaigns/statistics/removals + method: getRemovalStatistics + httpMethod: get + tag: Campaigns (https://apireference.getresponse.com/ + typeScriptTag: campaignsHttps:ApireferenceGetresponseCom + description: Get removal statistics + parameters: + - name: query[campaignId] + schema: string + required: true + description: '' + example: 3Va2e + - name: query[groupBy] + schema: string + required: false + description: '' + example: month + - name: query[createdOn][from] + schema: undefined + required: false + description: '' + - name: query[createdOn][to] + schema: undefined + required: false + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /campaigns/statistics/balance + method: getBalanceStatistics + httpMethod: get + tag: Campaigns (https://apireference.getresponse.com/ + typeScriptTag: campaignsHttps:ApireferenceGetresponseCom + description: Get balance statistics + parameters: + - name: query[campaignId] + schema: string + required: true + description: '' + example: 3Va2e + - name: query[groupBy] + schema: string + required: false + description: '' + example: month + - name: query[createdOn][from] + schema: undefined + required: false + description: '' + - name: query[createdOn][to] + schema: undefined + required: false + description: '' + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /campaigns/statistics/summary + method: getStatisticsSummary + httpMethod: get + tag: Campaigns (https://apireference.getresponse.com/ + typeScriptTag: campaignsHttps:ApireferenceGetresponseCom + description: Get the statistics summary for selected campaigns + parameters: + - name: query[campaignId] + schema: string + required: false + description: '' + example: 3Va2e + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /webforms + method: getList + httpMethod: get + tag: Legacy Forms + typeScriptTag: legacyForms + description: Get Legacy Forms. + parameters: + - name: query[name] + schema: string + required: false + description: Search Legacy Forms by name + - name: query[modifiedOn][from] + schema: string + required: false + description: Search Legacy Forms modified from this date + - name: query[modifiedOn][to] + schema: string + required: false + description: Search Legacy Forms modified to this date + - name: query[campaignId] + schema: string + required: false + description: >- + Search Legacy Forms by campaignId. Accepts multiple IDs separated with + a comma + - name: sort[modifiedOn] + schema: string + required: false + description: Sort Legacy Forms by modification date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /gdpr-fields + method: getList + httpMethod: get + tag: GDPR Fields + typeScriptTag: gdprFields + description: Get the GDPR fields list + parameters: + - name: sort[name] + schema: string + required: false + description: Sort fields by name + - name: sort[createdOn] + schema: string + required: false + description: Sort fields by creation date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /workflow + method: listWorkflows + httpMethod: get + tag: Workflows + typeScriptTag: workflows + description: Get workflows + parameters: + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /sms-automation + method: getList + httpMethod: get + tag: SMS Automation Messages + typeScriptTag: smsAutomationMessages + description: Get the list of automated SMS messages. + parameters: + - name: query[name] + schema: string + required: false + description: Search automated SMS messages by name + - name: query[campaignId] + schema: string + required: false + description: >- + Search automated SMS messages by campaign + (https://apireference.getresponse.com/ ID + - name: query[hasLinks] + schema: boolean + required: false + description: Search for automated SMS messages containing links + - name: sort[status] + schema: string + required: false + description: Sort by the status of the SMS message + - name: sort[name] + schema: string + required: false + description: Sort by the name of the automated SMS message + - name: sort[modifiedOn] + schema: string + required: false + description: Sort by the date the SMS message was modified on + - name: sort[delivered] + schema: string + required: false + description: Sort by the number of delivered SMS messages + - name: sort[sent] + schema: string + required: false + description: Sort by the number of sent SMS messages + - name: sort[clicks] + schema: string + required: false + description: Sort by the number of link clicks + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /sms + method: getList + httpMethod: get + tag: SMS Messages + typeScriptTag: smsMessages + description: Get the list of SMS messages. + parameters: + - name: query[type] + schema: string + required: false + description: Search SMS messages by type + - name: query[name] + schema: string + required: false + description: Search SMS messages by name + - name: query[sendingStatus] + schema: string + required: false + description: Search SMS messages by status + - name: query[campaignId] + schema: string + required: false + description: >- + Search SMS messages by campaign (https://apireference.getresponse.com/ + ID + - name: query[hasLinks] + schema: boolean + required: false + description: Search for SMS messages with links + - name: sort[sendingStatus] + schema: string + required: false + description: Sort by sending status + - name: sort[name] + schema: string + required: false + description: Sort by name + - name: sort[sendOn] + schema: string + required: false + description: Sort by sending date + - name: sort[modifiedOn] + schema: string + required: false + description: Sort by modification date + - name: sort[delivered] + schema: string + required: false + description: Sort by number of delivered messages + - name: sort[sent] + schema: string + required: false + description: Sort by number of sent messages + - name: sort[clicks] + schema: string + required: false + description: Sort by number of link clicks + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /autoresponders + method: getList + httpMethod: get + tag: Autoresponders + typeScriptTag: autoresponders + description: Get the list of autoresponders. + parameters: + - name: query[subject] + schema: string + required: false + description: Search autoresponder by subject + - name: query[name] + schema: string + required: false + description: Search autoresponder by name + - name: query[status] + schema: string + required: false + description: Search autoresponder by status + - name: query[createdOn][from] + schema: undefined + required: false + description: Search autoresponder created from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Search autoresponder created to this date + - name: query[campaignId] + schema: string + required: false + description: Search autoresponder by campaign ID + - name: query[type] + schema: string + required: false + description: Search autoresponder by type + - name: query[triggerType] + schema: string + required: false + description: Search autoresponder by triggerType + - name: sort[name] + schema: string + required: false + description: Sort by name + - name: sort[subject] + schema: string + required: false + description: Sort by subject + - name: sort[dayOfCycle] + schema: string + required: false + description: Sort by cycle day + - name: sort[delivered] + schema: string + required: false + description: Sort by delivered + - name: sort[openRate] + schema: string + required: false + description: Sort by open rate + - name: sort[clickRate] + schema: string + required: false + description: Sort by click rate + - name: sort[createdOn] + schema: string + required: false + description: Sort by date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /autoresponders + method: createNewAutoresponder + httpMethod: post + tag: Autoresponders + typeScriptTag: autoresponders + description: Create autoresponder + parameters: + - name: autoresponderId + schema: string + required: true + description: '' + example: Q + - name: href + schema: string + required: true + description: '' + example: https://api.getresponse.com/v3/autoresponders/Q + - name: name + schema: string + required: false + description: '' + example: Message 2 + - name: subject + schema: string + required: false + description: '' + example: test12 + - name: campaignId + schema: string + required: false + description: '' + example: V + - name: status + schema: string + required: false + description: '' + - name: editor + schema: string + required: false + description: '' + - name: fromField + schema: object + required: false + description: '' + - name: replyTo + schema: object + required: false + description: '' + - name: content + schema: object + required: false + description: '' + - name: flags + schema: array + required: false + description: '' + - name: sendSettings + schema: object + required: false + description: '' + - name: triggerSettings + schema: object + required: false + description: '' + - name: statistics + schema: object + required: false + description: '' + - name: createdOn + schema: string + required: false + description: '' + responses: + - statusCode: '201' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '409' + description: '' + - statusCode: '429' + description: '' + - url: /autoresponders/statistics + method: getAllStatistics + httpMethod: get + tag: Autoresponders + typeScriptTag: autoresponders + description: The statistics for all autoresponders + parameters: + - name: query[groupBy] + schema: string + required: false + description: Group results by time interval + - name: query[autoreponderId] + schema: string + required: false + description: The list of autoresponder resource IDs (string separated with '') + - name: query[campaignId] + schema: string + required: false + description: The list of campaign resource IDs (string separated with '') + - name: query[createdOn][from] + schema: undefined + required: false + description: Count data from this date + - name: query[createdOn][to] + schema: undefined + required: false + description: Count data to this date + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' + - url: /websites + method: getList + httpMethod: get + tag: Websites + typeScriptTag: websites + description: Get the list of websites + parameters: + - name: query[name] + schema: string + required: false + description: Search websites by name + - name: query[status] + schema: string + required: false + description: Search websites by status + - name: stats[from] + schema: string + required: false + description: Show statistics for websites from this date + - name: stats[to] + schema: string + required: false + description: Show statistics for websites to this date + - name: sort[name] + schema: string + required: false + description: Sort websites by name + - name: sort[createdAt] + schema: string + required: false + description: Sort websites by creation date + - name: sort[updatedAt] + schema: string + required: false + description: Sort websites by modification date + - name: sort[pageViews] + schema: string + required: false + description: Sort websites by page views + - name: sort[visits] + schema: string + required: false + description: Sort by number of site visits + - name: sort[uniqueVisitors] + schema: string + required: false + description: Sort by number of unique visitors + - name: fields + schema: string + required: false + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + - name: perPage + schema: integer + required: false + description: Requested number of results per page + default: 100 + - name: page + schema: integer + required: false + description: Page number + default: 1 + responses: + - statusCode: '200' + description: '' + - statusCode: '400' + description: '' + - statusCode: '401' + description: '' + - statusCode: '429' + description: '' +numberOfSchemas: 310 +apiDescription: > + + + # Limits and throttling + + + GetResponse API calls are subject to throttling to ensure a high level of + service for all users. + + + ## Time frame + + + Time frame is a period of time for which we calculate the API call limits. The + limits reset in every time frame. + + + The time frame duration is **10 minutes**. + + + ## Basic rate limits + + + Each user is allowed to make **30,000 API calls per time frame** (10 minutes) + and **80 API calls per second**. + + + ## Parallel requests limit + + + It is possible to send up to **10 simultaneous requests**. + + + ## Headers + + + Every API response includes a few additional headers: + + + * `X-RateLimit-Limit` – the total number of requests available per time + frame + + * `X-RateLimit-Remaining` – the number of requests left in the current time + frame + + * `X-RateLimit-Reset` – seconds left in the current time frame + + + ## Errors + + + The **429 Too Many Requests** HTTP response code indicates that the limit has + been reached. The error response includes `currentLimit` and `timeToReset` + fields in the context section, with the total number of requests available per + time frame and seconds left in the current time frame respectively. + + + ## Reaching the limit + + + When you reach the limit, you need to wait for the time specified in + `timeToReset` field or `X-RateLimit-Reset` header before making another + request. + + + # Authentication + + + API can be accessed by authenticated users only. This means that every request + must be signed with your credentials. We offer two methods of authentication: + API Key and OAuth 2.0. API key is our primary method and should be used in + most cases. GetResponse MAX clients have to send an `X-Domain` header in + addition to the API key. Supported OAuth 2.0 flows are: Authorization Code, + Client Credentials, Implicit, and Refresh Token. + + + ## API key + + + Follow these steps to send an authentication request: + + + * Find your unique and secret API key in the panel: + [https://app.getresponse.com/api](https://app.getresponse.com/api) + + * Add a custom `X-Auth-Token` header to all your requests. For example, if + your API key is `jfgs8jh4ksg93ban9Dfgh8`, the header will look like this: + + + ``` + + X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8 + + ``` + + + **For security reasons, unused API keys expire after 90 days. When that + happens, you’ll need to generate a new key to use our API.** + + + ### Example authenticated request + + + ``` + + $ curl -H "X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8" + https://api.getresponse.com/v3/accounts + + ``` + + + ## OAuth 2.0 + + + To use OAuth 2.0 authentication, you need to get an "Access Token". For more + information on how to obtain a token, head to our dedicated page: [OAuth + 2.0](/#section/Authentication/Using-OAuth-2.0) + + + To authenticate a request using an Access Token, set the value of + `Authorization` header to "Bearer" followed by the Access Token. + + + ### Example + + + If the Access Token is `jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8` + + + ``` + + Authorization: Bearer jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8 + + ``` + + + ## GetResponse MAX + + + GetResponse MAX customers need to take an extra step to authenticate the + request. All requests have to be send with an `X-Domain` header that contains + the client's domain. For example: + + + ``` + + X-Domain: example.com + + ``` + + + Please note that the header must contain only the domain name, without the + protocol identifier (`http://` or `https://`). + + + ## Using OAuth 2.0 + + + ### Registering your own application + + + If you want to use an OAuth flow to authorize your application, first + [register your application](https://app.getresponse.com/authorizations) + + + You need to provide a name, short description, and redirect URL. + + + ### Choosing grant flow + + + Once your application is registered, you can click on it to see your + `client_id` and `client_secret`. They're basically a login and password for + your application's access, so be sure not to share them with anyone. + + + Next, decide which authentication flow (grant type) you want to use. Here are + your options: + + + - choose the **Authorization Code** flow if your application is server-based + (you have a server with its own domain and server-side code), + + - choose the **Implicit** flow if your application is based mostly on + JavaScript or client-side code, + + - choose the **Client Credential** flow if you want to test your application + or access your GetResponse account, + + - implement the **Refresh Token** flow to handle token expiration if you use + the Authorization Code flow. + + + ### Authorization Code flow + + + First, your application must redirect a resource owner to the following URL: + + + ``` + + https://app.getresponse.com/oauth2_authorize.html?response_type=code&client_id=_your_client_id_&state=xyz + + ``` + + + The `state` parameter is there for security reasons and should be a random + string. When the resource owner grants your application access to the + resource, we will redirect the browser to the `redirect URL` you specified in + the application settings and attach the same state as the parameter. Comparing + the state parameter value ensures that the redirect was initiated by our + system. The code parameter is an authorization code that you can exchange for + an access token within 10 minutes, after which time it expires. + + + #### Example redirect with authorization code + + + ``` + + https://myredirecturi.com/cb?code=ed17c498bfe343175cd7684c5b09979f2875b25c&state=xyz + + ``` + + + #### Exchanging authorization code for the access token + + + Here's an example request to exchange authorization code for the access token: + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=authorization_code&code=ed17c498bfe343175cd7684c5b09979f2875b25c' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + ##### Example response + + + ```json + + { + "access_token": "03807cb390319329bdf6c777d4dfae9c0d3b3c35", + "expires_in": 3600, + "token_type": "Bearer", + "scope": null, + "refresh_token": "170d9f64e781aaa6b3ba036083faba71b2fc4e6c" + } + + ``` + + + ### Client Credentials flow + + + This flow is suitable for development, when you need to quickly access API to + create some functionality. You can get the access token with a single request: + + + #### Request + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=client_credentials' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + #### Response + + + ```json + + { + "access_token": "e2222af2851a912470ec33c9b4de1ea3a304b7d7", + "expires_in": 86400, + "token_type": "Bearer", + "scope": null + } + + ``` + + + You can also go to https://app.getresponse.com/manage_api.html, click the + action button for your application, and select "generate credentials". This + will open a popup with a generated access token. You can then use the access + token to authenticate your requests, for example: + + + ``` + + $ curl -H "Authorization: Bearer e2222af2851a912470ec33c9b4de1ea3a304b7d7" + https://api.getresponse.com/v3/from-fields + + ``` + + + ### Implicit flow + + + First, your application must redirect a resource owner to the following URL: + + + ``` + + https://app.getresponse.com/oauth2_authorize.html?response_type=token&client_id=_your_client_id_&redirect_uri=https://myredirecturi.com/cb&state=xyz + + ``` + + + When the resource owner grants your application access to the resource, we + will redirect the owner to the URL that was specified in the request. + + + There is no code exchange process because, unlike the Authorization Code flow, + the redirect already has the access token in the parameters. + + + ``` + + https://myredirecturi.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA&state=xyz&token_type=bearer&expires_in=3600 + + ``` + + + ### Refresh Token flow + + + You need to refresh your access token if you receive this error message as a + response to your request: + + + ```json + + { + "httpStatus": 401, + "code": 1014, + "codeDescription": "Problem during authentication process, check headers!", + "message": "The access token provided is expired", + "moreInfo": "https://apidocs.getresponse.com/v3/errors/1014", + "context": { + "sentToken": "b8b1e961a7f9fd4cc710d5d955e09c15a364ab71" + } + } + + ``` + + + If you are using the Authorization Code flow, you need to use the refresh + token to issue a new access token/refresh token pair by making the following + request: + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=refresh_token&refresh_token=170d9f64e781aaa6b3ba036083faba71b2fc4e6c' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + The response you'll get will look like this: + + + ```json + + { + "access_token": "890fdsa2f5d7b189fc4e6c4b1d170d9f591238ss", + "expires_in": 86400, + "token_type": "Bearer", + "scope": null, + "refresh_token": "170d9f64e781aaa6b3ba036083faba71b2fc4e6c" + } + + ``` + + + ### GetResponse MAX + + + There are some differences when authenticating GetResponse MAX users: + + + - the application must redirect to a page in the client's custom domain, for + example: `https://custom-domain.getresponse360.com/oauth2_authorize.html` + + - token requests have to be send to one of the GetResponse MAX APIv3 endpoints + (depending on the client's environment), + + - token requests have to include an `X-Domain` header, + + - the application has to be registered in a GetResponse MAX account within the + same environment. + + + + # CORS (AJAX requests) + + + [Cross-Origin Resource Sharing + (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) mechanism is + not supported by APIv3. It means that AJAX requests to the API will be blocked + by the browser's [same-origin + policy](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy). + Please use a server-side application to access the API. + + + + # Timezone settings + + + The default timezone in response data is **UTC**. + + + To set a different timezone, add `X-Time-Zone` header with value of [time zone + name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) ("TZ + database name" column). + + + + # Pagination + + + Most of the resource collections returned by API are paginated. It means that + the response is divided into multiple pages. + + + Control the number of results on each page by using `perPage` query parameter + and change pages by using `page` query parameter. + + + By default we return only the first **100** resources per page. You can change + that by adding `perPage` parameter with a value of up to **1000**. + + + Page numbers start with **1**. + + + Paginated responses have 3 extra headers: + + * `TotalCount` – a total number of resources on all pages + + * `TotalPages` – a total number of pages + + * `CurrentPage` – current page number + + + Use the maximum `perPage` value (**1000**) if you plan to iterate over all the + pages of the response. + + + When trying to get a page that exceeds the total number of pages, API will + return an empty array (`[]`). Make sure to stop iterating when it happens. + + + + # CURLE_SSL_CACERT error + + + Solution to CURLE_SSL_CACERT error (code 60). + + + This error is related to expired CA (Certificate Authority) certificates + installed on your server (the server that you send the requests from). You can + read more about certificate verification on the [cURL project + website](https://curl.haxx.se/docs/sslcerts.html). + + + If you encounter this error while sending requests to the GetResponse APIv3, + ask your server administrator to update the CA certificates using the [latest + bundle provided by the cURL + project](https://curl.haxx.se/docs/caextract.html). + + + **Please make sure that cURL is configured to use the updated bundle.** diff --git a/sdks/db/category-cache.yaml b/sdks/db/category-cache.yaml index c4560661c6..1eed18edd0 100644 --- a/sdks/db/category-cache.yaml +++ b/sdks/db/category-cache.yaml @@ -260,3 +260,4 @@ apis: TramitApp-undefined: HR Talent & Recruitment WANNME-undefined: Payment Processing Onna-undefined: Documents + GetResponse-undefined: Email diff --git a/sdks/db/custom-request-last-fetched.yaml b/sdks/db/custom-request-last-fetched.yaml index 7c2f360c12..04434b0171 100644 --- a/sdks/db/custom-request-last-fetched.yaml +++ b/sdks/db/custom-request-last-fetched.yaml @@ -25,16 +25,16 @@ lastUpdated: walmart.com_content: 2024-03-28T20:51:51.089Z zuora.com: 2024-03-28T20:51:52.218Z launchdarkly.com: 2024-03-28T20:51:58.598Z - klarna.com_payments: 2024-03-28T21:32:09.494Z - klarna.com_checkout: 2024-03-28T21:32:36.217Z - justeattakeaway.com: 2024-03-28T21:32:38.569Z - hetzner.com: 2024-03-28T21:32:39.991Z - hsbc.com_AccountInformationCE: 2024-03-28T21:32:58.708Z - zoom.us_meeting: 2024-03-28T21:33:01.555Z - snyk.com: 2024-03-28T21:33:02.820Z - clever.com: 2024-03-28T21:33:03.239Z - digitalocean.com: 2024-03-28T21:33:04.164Z - spotify.com_1.0.0: 2024-03-28T21:33:06.334Z + klarna.com_payments: 2024-03-28T21:35:37.719Z + klarna.com_checkout: 2024-03-28T21:35:53.013Z + justeattakeaway.com: 2024-03-28T21:35:55.120Z + hetzner.com: 2024-03-28T21:35:56.650Z + hsbc.com_AccountInformationCE: 2024-03-28T21:36:10.979Z + zoom.us_meeting: 2024-03-28T21:36:13.743Z + snyk.com: 2024-03-28T21:36:14.534Z + clever.com: 2024-03-28T21:36:14.767Z + digitalocean.com: 2024-03-28T21:36:15.448Z + spotify.com_1.0.0: 2024-03-28T21:36:16.007Z circleci.com: 2024-03-28T20:48:00.448Z brex.com_Team: 2024-03-28T20:52:04.351Z brex.com_Onboarding: 2024-03-28T20:52:18.319Z @@ -46,19 +46,19 @@ lastUpdated: resend.com: 2024-03-28T20:53:54.020Z griffin.com: 2024-03-28T20:53:53.564Z onedoc.com: 2024-03-28T20:47:59.508Z - box.com: 2024-03-28T21:32:40.780Z - asana.com: 2024-03-28T21:32:43.878Z - appwrite.io_Client: 2024-03-28T21:32:42.002Z - appwrite.io_Server: 2024-03-28T21:32:42.520Z - appwrite.io_Console: 2024-03-28T21:32:42.978Z - api.video: 2024-03-28T21:32:41.613Z + box.com: 2024-03-28T21:35:56.815Z + asana.com: 2024-03-28T21:35:57.535Z + appwrite.io_Client: 2024-03-28T21:35:57.163Z + appwrite.io_Server: 2024-03-28T21:35:57.219Z + appwrite.io_Console: 2024-03-28T21:35:57.368Z + api.video: 2024-03-28T21:35:57.099Z 1password.com_Connect: 2024-03-28T20:50:59.044Z 1password.com_Partnership: 2024-03-28T20:50:53.822Z zapier.com_Embed: 2024-03-28T20:51:25.397Z synclabs.so: 2024-03-28T20:51:24.575Z - uploadthing.com: 2024-03-28T21:33:03.692Z - crowdsec.net: 2024-03-28T21:33:06.550Z - crowd4cash.ch: 2024-03-28T21:33:08.721Z + uploadthing.com: 2024-03-28T21:36:15.203Z + crowdsec.net: 2024-03-28T21:36:16.073Z + crowd4cash.ch: 2024-03-28T21:36:18.384Z posthog.com: 2024-03-28T20:50:57.739Z visier.com_Authentication: 2024-03-28T20:51:43.944Z visier.com_ConsolidatedAnalytics: 2024-03-28T20:51:44.182Z @@ -72,17 +72,17 @@ lastUpdated: visier.com_TenantManagement: 2024-03-28T20:51:46.393Z visier.com_UserManagement: 2024-03-28T20:51:46.726Z shipengine.com: 2024-03-28T20:51:48.574Z - unstructured.io: 2024-03-28T21:34:01.398Z + unstructured.io: 2024-03-28T21:36:30.918Z vantage.sh: 2024-03-28T20:51:17.638Z baremetrics.com: 2024-03-28T20:51:17.151Z - nvidia.com_NIM: 2024-03-28T21:33:52.592Z - nvidia.com_CloudFunctions: 2024-03-28T21:34:01.225Z + nvidia.com_NIM: 2024-03-28T21:36:29.009Z + nvidia.com_CloudFunctions: 2024-03-28T21:36:30.885Z langfuse.com: 2024-03-28T20:48:53.664Z dots.dev: 2024-03-28T20:50:50.948Z seel.com: 2024-03-28T20:51:23.745Z - pay.com: 2024-03-28T21:34:20.535Z - agrimetrics.co.uk: 2024-03-28T21:33:42.061Z - tremendous.com: 2024-03-28T21:33:22.133Z + pay.com: 2024-03-28T21:36:36.797Z + agrimetrics.co.uk: 2024-03-28T21:36:26.901Z + tremendous.com: 2024-03-28T21:36:21.682Z notion.com: 2024-03-27T22:35:18.546Z payfactory.io: 2024-03-27T22:35:23.803Z helcim.com: 2024-03-27T22:35:25.444Z @@ -103,8 +103,8 @@ lastUpdated: 7shifts.com: 2024-03-28T19:25:40.710Z withterminal.com: 2024-03-28T20:50:53.417Z revenium.io: 2024-03-28T19:27:37.783Z - adp.com_WorkforceNow: 2024-03-28T21:30:49.736Z - alexishr.com: 2024-03-28T21:30:53.328Z + adp.com_WorkforceNow: 2024-03-28T21:35:24.788Z + alexishr.com: 2024-03-28T21:35:30.283Z clickfunnels.com: 2024-03-27T22:35:46.096Z beamable.com: 2024-03-27T22:35:15.955Z sumsub.com: 2024-03-27T22:35:50.915Z @@ -140,8 +140,8 @@ lastUpdated: suprsend.com: 2024-03-28T20:51:40.507Z officient.io: 2024-03-28T20:51:42.757Z okta.com: 2024-03-28T20:51:40.975Z - onelogin.com: 2024-03-28T21:30:53.919Z - sqala.tech: 2024-03-28T21:34:35.838Z + onelogin.com: 2024-03-28T21:35:30.852Z + sqala.tech: 2024-03-28T21:36:49.305Z peachpayments.com: 2024-03-27T22:35:53.010Z connexpay.com: 2024-03-27T23:06:45.738Z bluetime.io: 2024-03-27T23:14:28.071Z @@ -180,19 +180,19 @@ lastUpdated: salesflare.com: 2024-03-28T20:51:26.560Z teamwork.com: 2024-03-28T21:20:12.597Z zendesk.com: 2024-03-28T21:20:10.759Z - atlassian.com_BitBucket: 2024-03-28T21:34:21.373Z - dixa.com: 2024-03-28T21:34:27.411Z - gladly.com: 2024-03-27T21:35:33.703Z - softledger.com: 2024-03-28T21:34:50.576Z - gorgias.com: 2024-03-27T21:42:49.698Z - height.app: 2024-03-27T21:48:19.119Z - hive.com: 2024-03-27T21:51:42.769Z - intercom.com: 2024-03-27T21:55:21.938Z - tripadd.com: 2024-03-27T22:01:30.415Z - ironcladapp.com: 2024-03-27T22:02:28.116Z - leaflink.com: 2024-03-27T22:14:40.564Z - kustomer.com: 2024-03-27T22:22:39.799Z - uploadcare.com: 2024-03-27T22:22:29.644Z + atlassian.com_BitBucket: 2024-03-28T21:36:36.975Z + dixa.com: 2024-03-28T21:36:47.277Z + gladly.com: 2024-03-28T21:36:41.775Z + softledger.com: 2024-03-28T21:37:05.579Z + gorgias.com: 2024-03-28T22:33:31.155Z + height.app: 2024-03-28T22:32:38.071Z + hive.com: 2024-03-28T22:32:59.932Z + intercom.com: 2024-03-28T22:30:03.447Z + tripadd.com: 2024-03-28T22:33:35.232Z + ironcladapp.com: 2024-03-28T22:32:37.687Z + leaflink.com: 2024-03-28T22:33:39.873Z + kustomer.com: 2024-03-28T22:32:36.568Z + uploadcare.com: 2024-03-28T22:33:44.359Z shortcut.com: 2024-03-27T22:33:09.440Z spotdraft.com: 2024-03-27T22:42:19.772Z resistant.ai: 2024-03-27T22:35:57.655Z @@ -240,3 +240,4 @@ lastUpdated: tramitapp.com: 2024-03-28T22:16:07.724Z wannme.com: 2024-03-28T22:23:15.120Z onna.com: 2024-03-28T22:40:16.345Z + getresponse.com: 2024-03-28T22:30:02.555Z diff --git a/sdks/db/custom-request-specs/getresponse.com.yaml b/sdks/db/custom-request-specs/getresponse.com.yaml new file mode 100644 index 0000000000..01d9885dd8 --- /dev/null +++ b/sdks/db/custom-request-specs/getresponse.com.yaml @@ -0,0 +1,35044 @@ +openapi: 3.0.0 +info: + title: GetResponse APIv3 + description: > + + + # Limits and throttling + + + GetResponse API calls are subject to throttling to ensure a high level of + service for all users. + + + ## Time frame + + + Time frame is a period of time for which we calculate the API call limits. + The limits reset in every time frame. + + + The time frame duration is **10 minutes**. + + + ## Basic rate limits + + + Each user is allowed to make **30,000 API calls per time frame** (10 + minutes) and **80 API calls per second**. + + + ## Parallel requests limit + + + It is possible to send up to **10 simultaneous requests**. + + + ## Headers + + + Every API response includes a few additional headers: + + + * `X-RateLimit-Limit` – the total number of requests available per time + frame + + * `X-RateLimit-Remaining` – the number of requests left in the current + time frame + + * `X-RateLimit-Reset` – seconds left in the current time frame + + + ## Errors + + + The **429 Too Many Requests** HTTP response code indicates that the limit + has been reached. The error response includes `currentLimit` and + `timeToReset` fields in the context section, with the total number of + requests available per time frame and seconds left in the current time frame + respectively. + + + ## Reaching the limit + + + When you reach the limit, you need to wait for the time specified in + `timeToReset` field or `X-RateLimit-Reset` header before making another + request. + + + # Authentication + + + API can be accessed by authenticated users only. This means that every + request must be signed with your credentials. We offer two methods of + authentication: API Key and OAuth 2.0. API key is our primary method and + should be used in most cases. GetResponse MAX clients have to send an + `X-Domain` header in addition to the API key. Supported OAuth 2.0 flows are: + Authorization Code, Client Credentials, Implicit, and Refresh Token. + + + ## API key + + + Follow these steps to send an authentication request: + + + * Find your unique and secret API key in the panel: + [https://app.getresponse.com/api](https://app.getresponse.com/api) + + * Add a custom `X-Auth-Token` header to all your requests. For example, if + your API key is `jfgs8jh4ksg93ban9Dfgh8`, the header will look like this: + + + ``` + + X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8 + + ``` + + + **For security reasons, unused API keys expire after 90 days. When that + happens, you’ll need to generate a new key to use our API.** + + + ### Example authenticated request + + + ``` + + $ curl -H "X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8" + https://api.getresponse.com/v3/accounts + + ``` + + + ## OAuth 2.0 + + + To use OAuth 2.0 authentication, you need to get an "Access Token". For more + information on how to obtain a token, head to our dedicated page: [OAuth + 2.0](/#section/Authentication/Using-OAuth-2.0) + + + To authenticate a request using an Access Token, set the value of + `Authorization` header to "Bearer" followed by the Access Token. + + + ### Example + + + If the Access Token is `jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8` + + + ``` + + Authorization: Bearer jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8 + + ``` + + + ## GetResponse MAX + + + GetResponse MAX customers need to take an extra step to authenticate the + request. All requests have to be send with an `X-Domain` header that + contains the client's domain. For example: + + + ``` + + X-Domain: example.com + + ``` + + + Please note that the header must contain only the domain name, without the + protocol identifier (`http://` or `https://`). + + + ## Using OAuth 2.0 + + + ### Registering your own application + + + If you want to use an OAuth flow to authorize your application, first + [register your application](https://app.getresponse.com/authorizations) + + + You need to provide a name, short description, and redirect URL. + + + ### Choosing grant flow + + + Once your application is registered, you can click on it to see your + `client_id` and `client_secret`. They're basically a login and password for + your application's access, so be sure not to share them with anyone. + + + Next, decide which authentication flow (grant type) you want to use. Here + are your options: + + + - choose the **Authorization Code** flow if your application is server-based + (you have a server with its own domain and server-side code), + + - choose the **Implicit** flow if your application is based mostly on + JavaScript or client-side code, + + - choose the **Client Credential** flow if you want to test your application + or access your GetResponse account, + + - implement the **Refresh Token** flow to handle token expiration if you use + the Authorization Code flow. + + + ### Authorization Code flow + + + First, your application must redirect a resource owner to the following URL: + + + ``` + + https://app.getresponse.com/oauth2_authorize.html?response_type=code&client_id=_your_client_id_&state=xyz + + ``` + + + The `state` parameter is there for security reasons and should be a random + string. When the resource owner grants your application access to the + resource, we will redirect the browser to the `redirect URL` you specified + in the application settings and attach the same state as the parameter. + Comparing the state parameter value ensures that the redirect was initiated + by our system. The code parameter is an authorization code that you can + exchange for an access token within 10 minutes, after which time it expires. + + + #### Example redirect with authorization code + + + ``` + + https://myredirecturi.com/cb?code=ed17c498bfe343175cd7684c5b09979f2875b25c&state=xyz + + ``` + + + #### Exchanging authorization code for the access token + + + Here's an example request to exchange authorization code for the access + token: + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=authorization_code&code=ed17c498bfe343175cd7684c5b09979f2875b25c' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + ##### Example response + + + ```json + + { + "access_token": "03807cb390319329bdf6c777d4dfae9c0d3b3c35", + "expires_in": 3600, + "token_type": "Bearer", + "scope": null, + "refresh_token": "170d9f64e781aaa6b3ba036083faba71b2fc4e6c" + } + + ``` + + + ### Client Credentials flow + + + This flow is suitable for development, when you need to quickly access API + to create some functionality. You can get the access token with a single + request: + + + #### Request + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=client_credentials' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + #### Response + + + ```json + + { + "access_token": "e2222af2851a912470ec33c9b4de1ea3a304b7d7", + "expires_in": 86400, + "token_type": "Bearer", + "scope": null + } + + ``` + + + You can also go to https://app.getresponse.com/manage_api.html, click the + action button for your application, and select "generate credentials". This + will open a popup with a generated access token. You can then use the access + token to authenticate your requests, for example: + + + ``` + + $ curl -H "Authorization: Bearer e2222af2851a912470ec33c9b4de1ea3a304b7d7" + https://api.getresponse.com/v3/from-fields + + ``` + + + ### Implicit flow + + + First, your application must redirect a resource owner to the following URL: + + + ``` + + https://app.getresponse.com/oauth2_authorize.html?response_type=token&client_id=_your_client_id_&redirect_uri=https://myredirecturi.com/cb&state=xyz + + ``` + + + When the resource owner grants your application access to the resource, we + will redirect the owner to the URL that was specified in the request. + + + There is no code exchange process because, unlike the Authorization Code + flow, the redirect already has the access token in the parameters. + + + ``` + + https://myredirecturi.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA&state=xyz&token_type=bearer&expires_in=3600 + + ``` + + + ### Refresh Token flow + + + You need to refresh your access token if you receive this error message as a + response to your request: + + + ```json + + { + "httpStatus": 401, + "code": 1014, + "codeDescription": "Problem during authentication process, check headers!", + "message": "The access token provided is expired", + "moreInfo": "https://apidocs.getresponse.com/v3/errors/1014", + "context": { + "sentToken": "b8b1e961a7f9fd4cc710d5d955e09c15a364ab71" + } + } + + ``` + + + If you are using the Authorization Code flow, you need to use the refresh + token to issue a new access token/refresh token pair by making the following + request: + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=refresh_token&refresh_token=170d9f64e781aaa6b3ba036083faba71b2fc4e6c' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + The response you'll get will look like this: + + + ```json + + { + "access_token": "890fdsa2f5d7b189fc4e6c4b1d170d9f591238ss", + "expires_in": 86400, + "token_type": "Bearer", + "scope": null, + "refresh_token": "170d9f64e781aaa6b3ba036083faba71b2fc4e6c" + } + + ``` + + + ### GetResponse MAX + + + There are some differences when authenticating GetResponse MAX users: + + + - the application must redirect to a page in the client's custom domain, for + example: `https://custom-domain.getresponse360.com/oauth2_authorize.html` + + - token requests have to be send to one of the GetResponse MAX APIv3 + endpoints (depending on the client's environment), + + - token requests have to include an `X-Domain` header, + + - the application has to be registered in a GetResponse MAX account within + the same environment. + + + + # CORS (AJAX requests) + + + [Cross-Origin Resource Sharing + (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) mechanism is + not supported by APIv3. It means that AJAX requests to the API will be + blocked by the browser's [same-origin + policy](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy). + Please use a server-side application to access the API. + + + + # Timezone settings + + + The default timezone in response data is **UTC**. + + + To set a different timezone, add `X-Time-Zone` header with value of [time + zone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) + ("TZ database name" column). + + + + # Pagination + + + Most of the resource collections returned by API are paginated. It means + that the response is divided into multiple pages. + + + Control the number of results on each page by using `perPage` query + parameter and change pages by using `page` query parameter. + + + By default we return only the first **100** resources per page. You can + change that by adding `perPage` parameter with a value of up to **1000**. + + + Page numbers start with **1**. + + + Paginated responses have 3 extra headers: + + * `TotalCount` – a total number of resources on all pages + + * `TotalPages` – a total number of pages + + * `CurrentPage` – current page number + + + Use the maximum `perPage` value (**1000**) if you plan to iterate over all + the pages of the response. + + + When trying to get a page that exceeds the total number of pages, API will + return an empty array (`[]`). Make sure to stop iterating when it happens. + + + + # CURLE_SSL_CACERT error + + + Solution to CURLE_SSL_CACERT error (code 60). + + + This error is related to expired CA (Certificate Authority) certificates + installed on your server (the server that you send the requests from). You + can read more about certificate verification on the [cURL project + website](https://curl.haxx.se/docs/sslcerts.html). + + + If you encounter this error while sending requests to the GetResponse APIv3, + ask your server administrator to update the CA certificates using the + [latest bundle provided by the cURL + project](https://curl.haxx.se/docs/caextract.html). + + + **Please make sure that cURL is configured to use the updated bundle.** + contact: + name: API Support - DevZone + url: https://app.getresponse.com/feedback.html?devzone=yes + email: getresponse-devzone@cs.getresponse.com + version: 3.2024-03-04T09:53:07+0000 + x-logo: + url: https://us-ws.gr-cdn.com/images/global/getresponse.png +servers: + - url: https://api.getresponse.com/v3 + description: GetResponse + - url: https://api3.getresponse360.com/v3 + description: GetResponse MAX US + - url: https://api3.getresponse360.pl/v3 + description: GetResponse MAX PL +paths: + /webinars/{webinarId}: + get: + tags: + - Webinars + summary: Get a webinar by ID + operationId: getWebinarById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/WebinarDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/webinarId' + /contacts/{contactId}: + get: + tags: + - Contacts + summary: Get contact details by contact ID + operationId: getContactById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ContactDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Contacts + summary: Update contact details + description: >- + Skip the fields you don't want to update. If tags and custom fields are + provided, they'll be **replaced** with the values sent in this request. + If the `campaignId` changes, the contact will be moved from the original + campaign (list) to the new campaign (list). Their activity history and + statistics will also be moved. + operationId: updateContact + requestBody: + $ref: '#/components/requestBodies/UpdateContact' + responses: + '200': + $ref: '#/components/responses/ContactDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Contacts + summary: Delete a contact by contact ID + operationId: deleteContact + parameters: + - name: messageId + in: query + description: >- + > + + The ID of a message (such as a newsletter, an autoresponder, or an + RSS-newsletter). + + When passed, this method will simulate the unsubscribe process, as + if the contact clicked the unsubscribe link in a given message. + required: false + schema: + type: string + - name: ipAddress + in: query + description: >- + This makes it possible to pass the IP from which the contact + unsubscribed. Used only if the `messageId` was send. + schema: + type: string + format: ipv4 + responses: + '204': + description: Empty response. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/contactId' + /contacts/{contactId}/activities: + get: + tags: + - Contacts + summary: Get a list of contact activities + description: >- + By default, only activities from the last 14 days are returned. To get + earlier data, use `query[createdOn]` parameter. You can filter the + resource using criteria specified as `query[*]`. You can provide + multiple criteria, to use AND logic. You can sort the resource using + parameters specified as `sort[*]`. You can specify multiple fields to + sort by. + operationId: getActivities + parameters: + - name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ContactActivityList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/contactId' + /campaigns/{campaignId}/contacts: + get: + tags: + - Contacts + summary: Get contacts from a single campaign + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getContactsFromCampaign + parameters: + - name: query[email] + in: query + description: Search contacts by email + required: false + schema: + type: string + - name: query[name] + in: query + description: Search contacts by name + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[email] + in: query + description: Sort contacts by email + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + description: Sort contacts by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort contacts by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ContactList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/campaignId' + /contacts/{contactId}/custom-fields: + post: + tags: + - Contacts + summary: Upsert the custom fields of a contact + description: >- + Upsert (add or update) the custom fields of a contact. This method + doesn't remove (unassign) custom fields. + operationId: upsertContactCustoms + requestBody: + $ref: '#/components/requestBodies/UpsertContactCustomFields' + responses: + '200': + $ref: '#/components/responses/ContactCustomFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: upsert + parameters: + - $ref: '#/components/parameters/contactId' + /contacts/{contactId}/tags: + post: + tags: + - Contacts + summary: Upsert the tags of a contact + description: >- + Upsert (add or update) the tags of a contact. This method doesn't remove + (unassign) tags. + operationId: upsertTags + requestBody: + $ref: '#/components/requestBodies/UpsertContactTags' + responses: + '200': + $ref: '#/components/responses/UpsertContactTags' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: upsert + parameters: + - $ref: '#/components/parameters/contactId' + /search-contacts/{searchContactId}: + get: + tags: + - Search Contacts + summary: Get search contacts by contact ID. + description: Get the definition of a specific contact-search filter. + operationId: getSearchContactsById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SearchContactsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Search Contacts + summary: Update search contacts + description: Update specified search contacts. + operationId: updateSearchContacts + requestBody: + $ref: '#/components/requestBodies/UpdateSearchContacts' + responses: + '200': + $ref: '#/components/responses/SearchContactsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Search Contacts + summary: Delete search contacts + operationId: deleteSearchContacts + responses: + '204': + description: Delete search contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/searchContactId' + /search-contacts/{searchContactId}/contacts: + get: + tags: + - Search Contacts + summary: Get contacts by search contacts ID + description: Get contacts from saved search contacts by ID. + operationId: getContactsByIdSearchContacts + parameters: + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - name: sort[email] + in: query + description: Sort by email + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - name: sort[createdOn] + in: query + description: Sort by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: asc + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SearchedContactsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/searchContactId' + /search-contacts/{searchContactId}/custom-fields: + post: + tags: + - Search Contacts + summary: Upsert custom fields by search contacts + description: >- + Makes it possible to add and update custom field values for all contacts + that meet the search criteria. This method doesn't remove or overwrite + custom fields with the values from the request. + operationId: upsertCustomFieldsBySearchContactId + requestBody: + $ref: '#/components/requestBodies/UpsertContactCustomFields' + responses: + '202': + description: Upsert custom fields by searchContactId. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: UpsertCustomFieldsBySearchContactsId + parameters: + - $ref: '#/components/parameters/searchContactId' + /transactional-emails/templates/{transactionalTemplateId}: + get: + tags: + - Transactional Emails Templates + summary: Get a single template by ID + operationId: getTransactionalEmailsTemplatesById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailsTemplateDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + post: + tags: + - Transactional Emails Templates + summary: Update transactional email template + description: This method allows you to update transactional email template + operationId: updateTransactionalEmailsTemplate + requestBody: + $ref: '#/components/requestBodies/updateTransactionalEmailsTemplate' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailsTemplateDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + delete: + tags: + - Transactional Emails Templates + summary: Delete transactional email template + operationId: deleteTransactionalEmailsTemplate + responses: + '204': + description: Delete transactional email template + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + parameters: + - $ref: '#/components/parameters/transactionalTemplateId' + /transactional-emails/{transactionalEmailId}: + get: + tags: + - Transactional Emails + summary: Get transactional email details by transactional email ID + operationId: getTransactionalEmailsById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + parameters: + - $ref: '#/components/parameters/transactionalEmailId' + /from-fields/{fromFieldId}: + get: + tags: + - From Fields + summary: Get a single 'From' address by ID + operationId: getFromFieldById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/FromFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - From Fields + summary: Delete 'From' address + operationId: deleteFromField + parameters: + - name: fromFieldIdToReplaceWith + in: query + description: The 'From' address ID that should replace the deleted 'From' address + required: false + schema: + type: string + responses: + '204': + description: Delete 'From' address. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/fromFieldId' + /from-fields/{fromFieldId}/default: + post: + tags: + - From Fields + summary: Set a 'From' address as default + operationId: setFromFieldAsDefault + responses: + '200': + description: Set a 'From' address as default. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: SetDefaultFromField + x-no-body: true + x-type: update + parameters: + - $ref: '#/components/parameters/fromFieldId' + /rss-newsletters/{rssNewsletterId}: + get: + tags: + - RSS Newsletters + summary: Get RSS newsletter by ID + operationId: getRssNewsletterById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/RssNewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - RSS Newsletters + summary: Update RSS newsletter + operationId: updateRssNewsletter + requestBody: + $ref: '#/components/requestBodies/UpdateRssNewsletter' + responses: + '200': + $ref: '#/components/responses/RssNewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - RSS Newsletters + summary: Delete RSS newsletter + operationId: deleteRssNewsletter + responses: + '204': + description: Delete RSS newsletter. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/rssNewsletterId' + /rss-newsletters/{rssNewsletterId}/statistics: + get: + tags: + - RSS Newsletters + summary: Get RSS newsletter statistics by ID + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getSingleRssNewsletterStatisticsCollection + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SingleMessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetRssNewsletterStatistics + parameters: + - $ref: '#/components/parameters/rssNewsletterId' + /shops/{shopId}/taxes: + get: + tags: + - Taxes + summary: Get a list of taxes + description: >- + + Sending **GET** request to this URL returns a collection of tax + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below, in the request params + section). You can basically search by: + * name + * createdOn + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getTaxList + parameters: + - name: query[name] + in: query + description: Search tax by name + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search tax created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search tax created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TaxList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Taxes + summary: Create tax + description: > + + Sending a **POST** request to this URL will create a new tax resource. + + + In order to create a new tax, you need to send a tax resource in the + body of the request (remember that you need to serialize the body into a + JSON string) + operationId: createTax + requestBody: + $ref: '#/components/requestBodies/NewTax' + responses: + '201': + $ref: '#/components/responses/TaxDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: CreateTax + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/taxes/{taxId}: + get: + tags: + - Taxes + summary: Get a single tax by ID + description: > + + This method returns tax with a given `taxId` in the context of a given + `shopId` + operationId: getTaxById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TaxDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetTax + post: + tags: + - Taxes + summary: Update tax + description: > + + Update the properties of the shop tax. You should only send the fields + that need to be changed. The rest of the properties will stay the same. + operationId: updateTax + requestBody: + $ref: '#/components/requestBodies/UpdateTax' + responses: + '200': + $ref: '#/components/responses/TaxDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: UpdateTax + delete: + tags: + - Taxes + summary: Delete tax by ID + description: '' + operationId: deleteTax + responses: + '204': + description: Delete tax + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: DeleteTax + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/taxId' + /custom-events/{customEventId}: + get: + tags: + - Custom Events + summary: Get custom events by custom event ID + operationId: getCustomEventById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CustomEventDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Custom Events + summary: Update custom event details + operationId: updateCustomEvent + requestBody: + $ref: '#/components/requestBodies/UpdateCustomEvent' + responses: + '200': + $ref: '#/components/responses/CustomEventDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Custom Events + summary: Delete a custom event by custom event ID + operationId: deleteCustomEvent + responses: + '204': + description: Delete custom event + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/customEventId' + /forms/{formId}: + get: + tags: + - Forms + summary: Get form by ID + operationId: getForm + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/FormDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/formId' + /forms/{formId}/variants: + get: + tags: + - Forms + summary: Get the list of form variants (A/B tests) + operationId: getFormVariantList + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/FormVariantList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/formId' + /landing-pages/{landingPageId}: + get: + tags: + - Legacy Landing Pages + summary: Get single landing page by ID + operationId: getLandingPageById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LandingPageDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/landingPageId' + /imports/{importId}: + get: + tags: + - Imports + summary: Get import details by ID. + operationId: getImportById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ImportDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/importId' + /statistics/sms/{smsId}: + get: + tags: + - Sms + summary: Get details for the SMS message statistics + operationId: getSmsStats + parameters: + - name: query[createdOn][from] + in: query + description: Get statistics for a single SMS from this date + schema: + type: string + format: date + example: '2023-01-20' + - name: query[createdOn][to] + in: query + description: Get statistics for a single SMS to this date + schema: + type: string + format: date + example: '2023-01-20' + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SmsStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + parameters: + - $ref: '#/components/parameters/smsId' + /predefined-fields/{predefinedFieldId}: + get: + tags: + - Predefined Fields + summary: Get a predefined field by ID + description: Get detailed information about a specified predefined field. + operationId: getPredefinedFieldById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/PredefinedFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Predefined Fields + summary: Update a predefined field + operationId: updatePredefinedField + requestBody: + $ref: '#/components/requestBodies/UpdatePredefinedField' + responses: + '200': + $ref: '#/components/responses/PredefinedFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Predefined Fields + summary: Delete a predefined field + operationId: deletePredefinedField + responses: + '204': + description: Delete a predefined field. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/predefinedFieldId' + /shops/{shopId}/categories: + get: + tags: + - Categories + summary: Get the shop categories list + description: >- + + Sending a **GET** request to this URL returns a collection of category + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + *name + * createdOn + * parentId + + The `name` fields can be a pattern and we'll try to match this phrase. + + + The `parentId` will search for sub-categories of a given parent + category. + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getCategories + parameters: + - name: query[name] + in: query + description: Search category by name + required: false + schema: + type: string + - name: query[parentId] + in: query + description: Search categories by their parent + required: false + schema: + type: string + - name: query[externalId] + in: query + description: Search categories by external ID + required: false + schema: + type: string + - name: search[createdAt][from] + in: query + description: Show categories starting from this date + required: false + schema: + type: string + format: date-time + - name: search[createdAt][to] + in: query + description: Show categories starting to this date + required: false + schema: + type: string + format: date-time + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdAt] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CategoryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Categories + summary: Create category + description: >+ + + Create shop category. You can pass the `parentId` parameter to create a + sub-category of a given parent. Unlike most **POST** methods, this call + is idempotent, that is: sending the same request 10 times will not + create 10 new categories. Only one category will be created. + + operationId: createCategory + requestBody: + $ref: '#/components/requestBodies/NewCategory' + responses: + '201': + $ref: '#/components/responses/CategoryDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/categories/{categoryId}: + get: + tags: + - Categories + summary: Get a single category by ID + description: | + + This method returns a category according to the given `categoryId`. + operationId: getCategory + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CategoryDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Categories + summary: Update category + description: >+ + + Update the properties of the shop category. You can specify a `parentId` + to assign a category as sub-category for an existing category. You + should send only those fields that need to be changed. The rest of the + properties will stay the same. + + operationId: updateCategory + requestBody: + $ref: '#/components/requestBodies/UpdateCategory' + responses: + '200': + $ref: '#/components/responses/CategoryDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Categories + summary: Delete category + description: '' + operationId: deleteCategory + responses: + '204': + description: Delete category + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/categoryId' + /suppressions/{suppressionId}: + get: + tags: + - Suppressions + summary: Get a suppression list by ID + operationId: getSuppressionById + responses: + '200': + $ref: '#/components/responses/SuppressionDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Suppressions + summary: Update a suppression list by ID + operationId: updateSuppression + requestBody: + description: The suppression list to be updated. + $ref: '#/components/requestBodies/UpdateSuppression' + responses: + '200': + $ref: '#/components/responses/SuppressionDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Suppressions + summary: Deletes a given suppression list by ID + operationId: deleteSuppression + responses: + '204': + description: Suppression list deleted successfully. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/suppressionId' + /shops/{shopId}/orders: + get: + tags: + - Orders + summary: Get the list of orders + description: >- + + Sending a **GET** request to this URL returns a collection of order + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + * description + * status + * externalId + * processedAt + + The `description` fields can be a pattern and we'll try to match this + phrase. + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getOrderList + parameters: + - name: query[description] + in: query + description: Search order by description + required: false + schema: + type: string + - name: query[status] + in: query + description: Search order by status + required: false + schema: + type: string + - name: query[externalId] + in: query + description: Search order by external ID + required: false + schema: + type: string + - name: query[processedAt][from] + in: query + description: Show orders processed from this date + required: false + schema: + type: string + format: date-time + - name: query[processedAt][to] + in: query + description: Show orders processed to this date + required: false + schema: + type: string + format: date-time + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/OrderList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Orders + summary: Create order + description: >+ + + Sending a **POST** request to this URL will create a new order resource. + + + In order to create a new order, you need to send the order resource in + the body of the request (remember that you need to serialize the body + into a JSON string). + + operationId: createOrder + parameters: + - name: additionalFlags + in: query + description: >- + The additional flags parameter with the value `skipAutomation` will + skip the triggering `Make a purchase` element in an automated + workflow + required: false + schema: + type: string + example: skipAutomation + x-set: + - skipAutomation + requestBody: + $ref: '#/components/requestBodies/NewOrder' + responses: + '201': + $ref: '#/components/responses/OrderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/orders/{orderId}: + get: + tags: + - Orders + summary: Get a single order by ID + description: |+ + + This method returns the order according to the given `orderId`. + + operationId: getOrderById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/OrderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Orders + summary: Update order + description: >+ + + Update the properties of a shop's order. You should send only those + fields that need to be changed. The rest of the properties will stay the + same. + + However, in case of `billingAddress` and `shippingAddress`, you must + send the entire representation. Individual fields can't be updated. + + If you want to update individual fields of an address, you can do so + using `POST /v3/addresses/{addressId}`. + + + In case of `selectedVariants`, when the collection is updated, the old + collection is completely removed. The same goes for meta fields. + + Individual fields can't be updated either. The full representations of + `selectedVariants` and `metaFields` must be sent instead. + + operationId: updateOrder + parameters: + - name: additionalFlags + in: query + description: >- + The additional flags parameter with the value `skipAutomation` will + skip the triggering `Make a purchase` element in an automated + workflow + required: false + schema: + type: string + example: skipAutomation + x-set: + - skipAutomation + requestBody: + $ref: '#/components/requestBodies/UpdateOrder' + responses: + '200': + $ref: '#/components/responses/OrderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Orders + summary: Delete order + description: '' + operationId: deleteOrder + responses: + '204': + description: Delete order + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/orderId' + /shops/{shopId}/products: + get: + tags: + - Products + summary: Get a product list. + description: >- + + Sending a **GET** request to this URL returns a collection of product + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + * name + * vendor + * category + * categoryId + * externalId + * variantName + * metaFieldNames + * metaFieldValues + * createdOn + + The `metaFieldNames` and `metaFieldValues` fields can be a list of + values separated by a comma [,]. + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getProductList + parameters: + - name: query[name] + in: query + description: Search products by name + required: false + schema: + type: string + - name: query[vendor] + in: query + description: Search products by vendor + required: false + schema: + type: string + - name: query[category] + in: query + description: Search products by category name + required: false + schema: + type: string + - name: query[categoryId] + in: query + description: Search products by category ID + required: false + schema: + type: string + - name: query[externalId] + in: query + description: Search products by external ID + required: false + schema: + type: string + - name: query[variantName] + in: query + description: Search products by product variant name + required: false + schema: + type: string + - name: query[metaFieldNames] + in: query + description: >- + Search products by meta field name (the list of names must be + separated by a comma [,]) + required: false + schema: + type: string + - name: query[metaFieldValues] + in: query + description: >- + Search products by meta field value (the list of values must be + separated by a comma [,]) + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search products created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search products created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ProductList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Products + summary: Create product + description: >+ + + Sending a **POST** request to this URL will create a new product + resource. + + + In order to create a new product, you need to send the product resource + in the body of the request (remember that you need to serialize the body + into a JSON string) + + + You don't need a separate endpoint for each element (e.g. variant, + category, meta-field). You can create them all with this method. + + + Please note that categories aren't required, but if a product has at + least one category, then one of those categories must be marked as + default. + + This can be set by field `isDefault`. If none of the elements contains + isDefault=true, then the system picks the first one from the collection + by default. + + operationId: createProduct + requestBody: + $ref: '#/components/requestBodies/NewProduct' + responses: + '201': + $ref: '#/components/responses/ProductDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/products/{productId}: + get: + tags: + - Products + summary: Get a single product by ID + description: >+ + + This method returns product according to the given `productId` in the + context of a given `shopId`. + + operationId: getProductById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ProductDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Products + summary: Update product + description: >+ + + Update the properties of a shop's product. You should only send those + fields that need to be changed. The remaining properties will stay the + same. + + However, when updating variants, categories, and meta fields, you need + to send entire collections. Individual fields can't be updated. + + If you want to update particular fields, you can do so using their + specific endpoints, i.e.: + + * categories - `POST /v3/shops/{shopId}/categories/{categoryId}` + * variants - POST `/v3/shops/{shopId}/products/{productId}/variants/{variantId}` + * metaFields - `POST /v3/shops/{shopId}/meta-fields/{metaFieldId}` + + + operationId: updateProduct + requestBody: + $ref: '#/components/requestBodies/UpdateProduct' + responses: + '200': + $ref: '#/components/responses/ProductDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Products + summary: Delete product + description: '' + operationId: deleteProduct + responses: + '204': + description: Delete product + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + /shops/{shopId}/products/{productId}/categories: + post: + tags: + - Products + summary: Upsert product categories + description: >+ + + This method makes it possible to assign product categories, and to set a + default product category. This method doesn't remove or unassign product + categories. It returns a list of product categories. + + + Please note that if you assign only one category to a given product, + that category is marked as default. If you try to remove the default + mark, your change won't be executed. + + operationId: upsertProductCategories + requestBody: + $ref: '#/components/requestBodies/UpsertProductCategory' + responses: + '200': + $ref: '#/components/responses/SimpleProductCategoryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: upsert + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + /shops/{shopId}/products/{productId}/meta-fields: + post: + tags: + - Products + summary: Upsert product meta fields + description: >+ + + This method makes it possible to assign meta fields. It doesn't remove + or unassign meta fields. It returns a list of product meta fields. + + operationId: upsertMetaFields + requestBody: + $ref: '#/components/requestBodies/UpsertMetaField' + responses: + '200': + $ref: '#/components/responses/MetaFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: upsert + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + /shops/{shopId}: + get: + tags: + - Shops + summary: Get a single shop by ID + description: |+ + + This method returns the shop according to the given `shopId` + + operationId: getShopById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ShopDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Shops + summary: Update shop + description: >+ + + This makes it possible to update shop preferences. You should send only + those fields that need to be changed. The rest of the properties remain + the same. + + operationId: updateShop + requestBody: + $ref: '#/components/requestBodies/UpdateShop' + responses: + '200': + $ref: '#/components/responses/ShopDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Shops + summary: Delete shop + description: |+ + + This method deletes a shop. + + operationId: deleteShop + responses: + '204': + description: Delete a shop + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /popups/{popupId}: + get: + tags: + - Forms and Popups + summary: Get a single form or popup by ID + operationId: getPopupDetails + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/PopupDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/popupId' + /statistics/popups/{popupId}/performance: + get: + tags: + - Form and Popup + summary: Get statistics for a single form or popup + operationId: getPopupGeneralPerformance + parameters: + - name: query[date][from] + in: query + description: Get statistics for a single form or popup from this date + required: false + schema: + type: string + format: date + example: '2023-01-10' + - name: query[date][to] + in: query + description: Get statistics for a single form or popup to this date + required: false + schema: + type: string + format: date + example: '2023-01-20' + - name: query[location] + in: query + description: Form or popup statistics by location + required: false + schema: + type: string + - name: query[device] + in: query + description: Form or popup statistics by device + required: false + schema: + type: string + enum: + - desktop + - mobile + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/PopupGeneralPerformance' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/popupId' + /splittests/{splittestId}: + get: + tags: + - A/B tests + summary: Get a single A/B test. + description: Get a single A/B test by ID. + operationId: getSplittest + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/Splittest' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/splittestId' + /shops/{shopId}/carts: + get: + tags: + - Carts + summary: Get shop carts + description: >- + + Sending a **GET** request to this URL returns a collection of cart + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * externalId + * createdOn + + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getCarts + parameters: + - name: query[createdOn][from] + in: query + description: Search carts created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search carts created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[externalId] + in: query + description: Search cart by external ID + required: false + schema: + type: string + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CartList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Carts + summary: Create cart + description: >+ + + Sending a **POST** request to this URL will create a new cart resource. + + + In order to create a new cart, you need to send the cart resource in the + body of the request (remember that you need to serialize the body into a + JSON string) + + operationId: createCart + requestBody: + $ref: '#/components/requestBodies/NewCart' + responses: + '201': + $ref: '#/components/responses/CartDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/carts/{cartId}: + get: + tags: + - Carts + summary: Get cart by ID + description: >+ + + This method returns cart with the given `cartId` in the context of a + given `shopId` + + operationId: getCart + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CartDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Carts + summary: Update cart + description: >+ + + Update properties of the shop cart. You should send only those fields + that need to be changed. The rest of the properties will stay the same. + + + In case of selectedVariants, when the collection is updated, the old one + is completely removed. + + operationId: updateCart + requestBody: + $ref: '#/components/requestBodies/UpdateCart' + responses: + '200': + $ref: '#/components/responses/CartDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Carts + summary: Delete cart + description: '' + operationId: deleteCart + responses: + '204': + description: Delete cart + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/cartId' + /file-library/files/{fileId}: + get: + tags: + - File Library + summary: Get file by ID + operationId: getFileById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/File' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - File Library + summary: Delete file by file ID + operationId: deleteFile + responses: + '204': + description: Delete file + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/fileId' + /file-library/folders/{folderId}: + delete: + tags: + - File Library + summary: Delete folder by folder ID + operationId: deleteFolder + responses: + '204': + description: Delete folder + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/folderId' + /ab-tests/subject/{abTestId}: + get: + tags: + - A/B tests - subject + summary: Get a single A/B test by ID + operationId: getAbtestsSubjectById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AbtestsSubjectGetDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/abTestId' + /ab-tests/subject/{abTestId}/winner: + post: + tags: + - A/B tests - subject + summary: Choose A/B test winner + operationId: postAbtestsSubjectByIdWinner + requestBody: + $ref: '#/components/requestBodies/ChooseWinnerAbtestsSubject' + responses: + '204': + description: Choose A/B test winner + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/abTestId' + /click-tracks/{clickTrackId}: + get: + tags: + - Click Tracks + summary: Get click tracked link details by click track ID + operationId: getClickTrackById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ClickTrack' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/clickTrackId' + /newsletters/{newsletterId}: + get: + tags: + - Newsletters + summary: Get a single newsletter by its ID. + operationId: getNewsletter + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Newsletters + summary: Delete newsletter + operationId: deleteNewsletter + responses: + '204': + description: Delete newsletter. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/newsletterId' + /newsletters/{newsletterId}/activities: + get: + tags: + - Newsletters + summary: Get newsletter activities + description: >- + By default, activities from the **last 14 days** are listed only. You + can get activities for last 30 days only. You can filter the resource + using criteria specified as `query[*]`. You can provide multiple + criteria, to use AND logic. You can sort the resource using parameters + specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getNewsletterActivities + parameters: + - name: query[activity] + in: query + description: Search newsletter activities by activity type + required: false + schema: + type: string + enum: + - send + - open + - click + - name: query[createdOn][from] + in: query + description: >- + Search newsletter activities from this date. Default value is 14 + days earlier. You can get activities for last 30 days only. + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search newsletter activities to this date. Default value is now + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/NewsletterActivities' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/newsletterId' + /newsletters/{newsletterId}/cancel: + post: + tags: + - Newsletters + summary: Cancel sending the newsletter + description: > + > + + Using this method, you can cancel the sending of the newsletter. It will + also turn the newsletter into a **draft**. + operationId: cancelMessageSend + responses: + '200': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: CancelNewsletter + x-no-body: true + parameters: + - $ref: '#/components/parameters/newsletterId' + /newsletters/{newsletterId}/thumbnail: + get: + tags: + - Newsletters + summary: Get newsletter thumbnail + operationId: getNewsletterThumbnail + parameters: + - name: size + in: query + description: The size of the thumbnail + required: false + schema: + type: string + default: default + enum: + - default + - small + responses: + '200': + description: The newsletter thumbnail. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + image/*: + schema: + type: string + format: binary + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: get + x-operation-class-name: GetNewsletterThumbnail + parameters: + - $ref: '#/components/parameters/newsletterId' + /newsletters/{newsletterId}/statistics: + get: + tags: + - Newsletters + summary: The statistics of single newsletter + description: >- + > + + This makes it possible to easily fetch statistics for a single + newsletter. You can group the data hourly, daily, monthly and as a + + total sum. Remember that all statistics date ranges are given in + standard UTC period type objects. + + ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)). + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getSingleNewsletterStatistics + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SingleMessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetNewsletterStatistics + parameters: + - $ref: '#/components/parameters/newsletterId' + /tags/{tagId}: + get: + tags: + - Tags + summary: Get tag by ID + operationId: getTagById + parameters: + - name: tagId + in: path + description: The tag ID + required: true + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TagDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Tags + summary: Update tag by ID + operationId: updateTag + requestBody: + $ref: '#/components/requestBodies/UpdateTag' + responses: + '200': + $ref: '#/components/responses/TagDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Tags + summary: Delete tag by ID + operationId: deleteTag + responses: + '204': + description: Tag deleted successfully. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/tagId' + /addresses/{addressId}: + get: + tags: + - Addresses + summary: Get an address by ID + description: '' + operationId: getAddress + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AddressDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Addresses + summary: Update address + description: > + + Update an existing address. You should send only those fields that need + to be changed. The rest of the properties will stay the same. + operationId: updateAddress + requestBody: + $ref: '#/components/requestBodies/UpdateAddress' + responses: + '200': + $ref: '#/components/responses/AddressDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Addresses + summary: Delete address + description: '' + operationId: deleteAddress + responses: + '204': + description: Empty response + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/addressId' + /campaigns/{campaignId}/blocklists: + get: + tags: + - Campaigns (Lists) + summary: Returns campaign blocklist masks + operationId: getCampaignBlocklist + parameters: + - name: query[mask] + in: query + description: Blocklist mask to search for + required: false + schema: + type: string + example: '@somedomain.com' + responses: + '200': + $ref: '#/components/responses/CampaignBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Campaigns (Lists) + summary: Updates campaign blocklist masks + operationId: updateCampaignBlocklist + parameters: + - name: additionalFlags + in: query + description: >- + The flag value `add` adds the masks provided in the request body to + your blocklist. The flag value `delete` deletes the masks. The masks + are replaced if there are no flag values in the request body. + + For better performance, use the flag value `noResponse`. It removes the response body and can be used alone or combined with other flags. If multiple flags are used, separate them by a comma, like this: `additionalFlags=noResponse` or `additionalFlags=add,noResponse`. + required: false + schema: + type: string + enum: + - add + - delete + - noResponse + requestBody: + $ref: '#/components/requestBodies/UpdateCampaignBlocklist' + responses: + '200': + $ref: '#/components/responses/CampaignBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: update + parameters: + - $ref: '#/components/parameters/campaignId' + /custom-fields/{customFieldId}: + get: + tags: + - Custom Fields + summary: Get a single custom field definition by the custom field ID + operationId: getCustomFieldById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CustomFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Custom Fields + summary: Update the custom field definition + operationId: updateCustomField + requestBody: + $ref: '#/components/requestBodies/UpdateCustomField' + responses: + '200': + $ref: '#/components/responses/CustomFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Custom Fields + summary: Delete a single custom field definition + operationId: deleteCustomField + responses: + '204': + description: Delete a custom field. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/customFieldId' + /lps/{lpsId}: + get: + tags: + - Landing Pages + summary: Get a single landing page by ID + operationId: getLpsById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LpsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/lpsId' + /statistics/lps/{lpsId}/performance: + get: + tags: + - Landing Page + summary: Get details for landing page statistics + operationId: getLpsGeneralPerformanceStats + parameters: + - name: query[date][from] + in: query + description: Show a single landing page statistics from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[date][to] + in: query + description: Show a single landing page statistics to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[location] + in: query + description: Landing page statistics by location + required: false + schema: + type: string + - name: query[device] + in: query + description: Landing page statistics by device + required: false + schema: + type: string + enum: + - desktop + - mobile + - name: query[page] + in: query + description: Landing page statistics by page UUID + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LpsStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/lpsId' + /shops/{shopId}/products/{productId}/variants: + get: + tags: + - Product Variants + summary: Get a list of product variants + description: >+ + + Sending a **GET** request to this URL returns a collection of product + variant resources that belong to the given shop and product. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + + * sku + + * description + + + The `description` fields can be a pattern and we'll try to match this + phrase. + + operationId: getProductVariantList + parameters: + - name: query[name] + in: query + description: Search variant by name + required: false + schema: + type: string + - name: query[sku] + in: query + description: Search variant by SKU + required: false + schema: + type: string + - name: query[description] + in: query + description: Search variant by description + required: false + schema: + type: string + - name: query[externalId] + in: query + description: Search variant by external ID + required: false + schema: + type: string + - name: query[createdAt][from] + in: query + description: Show variants starting from this date + required: false + schema: + type: string + format: date-time + - name: query[createdAt][to] + in: query + description: Show variants starting to this date + required: false + schema: + type: string + format: date-time + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ProductVariantList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Product Variants + summary: Create product variant + description: >+ + + Sending a **POST** request to this URL will create a new product variant + resource. + + + In order to create a new product variant, you need to send a product + variant resource in the body of the request (remember that you need to + serialize the body into a JSON string) + + + There is no need to create every element (like: image, meta field, tax) + one by one by their own endpoints. All these elements can be created + during this method. + + operationId: createProductVariant + requestBody: + $ref: '#/components/requestBodies/NewProductVariant' + responses: + '201': + $ref: '#/components/responses/ProductVariantDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + /shops/{shopId}/products/{productId}/variants/{variantId}: + get: + tags: + - Product Variants + summary: Get a single product variant by ID + description: >+ + + This method returns product variant according to the given `variantId` + in the context of a given `shopId` and `productId` + + operationId: getProductVariantById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ProductVariantDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Product Variants + summary: Update product variant + description: >+ + + Update properties of a product variant. You should send only those + fields that need to be changed. The remaining properties will stay the + same. However, when updating metafields, images, and taxes, you need to + send entire collections. Individual fields can't be updated. If you want + to update particular metafields or tax resources, you can do so using + their particular endpoints, i.e: + + * taxes - `POST /v3/shops/{shopId}/taxes/{taxId}` + * metaFields - `POST /v3/shops/{shopId}/meta-fields/{metaFieldId}` + + operationId: updateProductVariant + requestBody: + $ref: '#/components/requestBodies/UpdateProductVariant' + responses: + '200': + $ref: '#/components/responses/ProductVariantDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Product Variants + summary: Delete product variant + description: '' + operationId: deleteProductVariant + responses: + '204': + description: Delete product variant + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + - $ref: '#/components/parameters/variantId' + /campaigns/{campaignId}: + get: + tags: + - Campaigns (Lists) + summary: Get a single campaign by the campaign ID + operationId: getCampaign + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/Campaign' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Campaigns (Lists) + summary: Update a campaign + operationId: updateCampaign + requestBody: + $ref: '#/components/requestBodies/UpdateCampaign' + responses: + '200': + $ref: '#/components/responses/Campaign' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/campaignId' + /shops/{shopId}/meta-fields: + get: + tags: + - Meta Fields + summary: Get the shop meta fields + description: >- + + Sending a **GET** request to this URL returns a collection of meta field + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + * value + * description + * createdOn + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getMetaFields + parameters: + - name: query[name] + in: query + description: Search meta fields by name + required: false + schema: + type: string + - name: query[description] + in: query + description: Search meta fields by description + required: false + schema: + type: string + - name: query[value] + in: query + description: Search meta fields by value + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search meta fields created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search meta fields created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MetaFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Meta Fields + summary: Create meta field + description: > + + Sending a **POST** request to this URL will create a new meta field + resource. + + + In order to create a new meta field, you need to send a meta field + resource in the body of the request (remember that you need to serialize + the body into a JSON string) + operationId: createMetaField + requestBody: + $ref: '#/components/requestBodies/NewMetaField' + responses: + '201': + $ref: '#/components/responses/MetaFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/meta-fields/{metaFieldId}: + get: + tags: + - Meta Fields + summary: Get the meta field by ID + description: > + + This method returns meta field with a given `metaFieldId` in the context + of a given `shopId` + operationId: getMetaField + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/MetaFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Meta Fields + summary: Update meta field + description: > + + Update the properties of a shop's meta field. You should send only those + fields that need to be changed. The rest of the properties will stay the + same. + operationId: updateMetaField + requestBody: + $ref: '#/components/requestBodies/UpdateMetaField' + responses: + '200': + $ref: '#/components/responses/MetaFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Meta Fields + summary: Delete meta field + description: '' + operationId: deleteMetaField + responses: + '204': + description: Delete meta field + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/metaFieldId' + /webforms/{webformId}: + get: + tags: + - Legacy Forms + summary: Get Legacy Form by ID. + description: Get Legacy Form by ID. + operationId: getLegacyFormById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LegacyForm' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/webformId' + /gdpr-fields/{gdprFieldId}: + get: + tags: + - GDPR Fields + summary: Get GDPR Field details + operationId: getGDPRField + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/GDPRFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/gdprFieldId' + /workflow/{workflowId}: + get: + tags: + - Workflows + summary: Get workflow by ID + description: Get a single workflow by ID. + operationId: getWorkflow + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/Workflow' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Workflows + summary: Update workflow + description: Update single workflow. + operationId: updateWorkflow + requestBody: + $ref: '#/components/requestBodies/UpdateWorkflow' + responses: + '200': + $ref: '#/components/responses/Workflow' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/workflowId' + /sms/{smsId}: + get: + tags: + - SMS Messages + summary: Get a single SMS message by its ID + operationId: getSmsById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SmsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + parameters: + - $ref: '#/components/parameters/smsId' + /autoresponders/{autoresponderId}: + get: + tags: + - Autoresponders + summary: Get a single autoresponder by its ID + operationId: getAutoresponder + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AutoresponderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Autoresponders + summary: Update autoresponder + description: > + > + + **The action-based autoresponder feature has been migrated over to + marketing automation. Your existing autoresponders are + + now converted into workflows. You can no longer create and update + action-based autoresponders using our API.** + + + This method allows you to update an autoresponder. The same rules as in + creating an autoresponder apply. + operationId: updateAutoresponder + requestBody: + $ref: '#/components/requestBodies/UpdateAutoresponder' + responses: + '200': + $ref: '#/components/responses/AutoresponderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Autoresponders + summary: Delete autoresponder. + operationId: deleteAutoresponder + responses: + '204': + description: Delete autoresponder + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/autoresponderId' + /autoresponders/{autoresponderId}/thumbnail: + get: + tags: + - Autoresponders + summary: Get the autoresponder thumbnail + operationId: getAutoresponderThumbnail + parameters: + - name: size + in: query + description: The size of the autoresponder thumbnail + required: false + schema: + type: string + default: default + enum: + - default + - small + responses: + '200': + description: The autoresponder thumbnail. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + image/*: + schema: + type: string + format: binary + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: get + x-operation-class-name: GetAutoresponderThumbnail + parameters: + - $ref: '#/components/parameters/autoresponderId' + /autoresponders/{autoresponderId}/statistics: + get: + tags: + - Autoresponders + summary: The statistics for a single autoresponder + description: >- + > + + This requst returns the statistics summary for a single given + autoresponder. As in all statistics, you can change the date and time + range (hourly daily monthly or total). Keep in mind + + that all statistics date ranges are given in standard UTC period type + objects. ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)) + + + (https://app.getresponse.com/statistics.html?t=followup#total). + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getSingleAutoresponderStatistics + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SingleMessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetAutoresponderStatistics + parameters: + - $ref: '#/components/parameters/autoresponderId' + /websites/{websiteId}: + get: + tags: + - Websites + summary: Get a single Website by ID + operationId: getWebsiteById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/WebsiteDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/websiteId' + /statistics/wbe/{websiteId}/performance: + get: + tags: + - Website + summary: Get details for website statistics + operationId: getWbeGeneralPerformanceStats + parameters: + - name: query[date][from] + in: query + description: Show a single website statistics from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[date][to] + in: query + description: Show a single website statistics to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[location] + in: query + description: Website statistics by location + required: false + schema: + type: string + - name: query[device] + in: query + description: Website statistics by device + required: false + schema: + type: string + enum: + - desktop + - mobile + - name: query[page] + in: query + description: Website statistics by a page UUID + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/WebsiteStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/websiteId' + /webinars: + get: + tags: + - Webinars + summary: Get a list of webinars + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getWebinarList + parameters: + - name: query[name] + in: query + description: Search webinars by name + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: The list of campaign resource IDs (string separated with ',') + required: false + schema: + type: string + - name: query[status] + in: query + description: Search webinars by status + required: false + schema: + type: string + enum: + - upcoming + - finished + - published + - unpublished + - name: sort[name] + in: query + description: Sort webinars by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort webinars by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[startsOn] + in: query + description: Sort webinars by update date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: query[type] + in: query + description: Search webinars by type + required: false + schema: + type: string + enum: + - all + - live + - on_demand + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/WebinarList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /contacts: + get: + tags: + - Contacts + summary: Get contact list + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getContactList + parameters: + - name: query[email] + in: query + description: Search contacts by email + required: false + schema: + type: string + - name: query[name] + in: query + description: Search contacts by name + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: Search contacts by campaign ID + required: false + schema: + type: string + - name: query[origin] + in: query + description: Search contacts by origin + required: false + schema: + type: string + enum: + - import + - email + - www + - panel + - leads + - sale + - api + - forward + - survey + - iphone + - copy + - landing_page + - webinar + - website_builder_elegant + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[changedOn][from] + in: query + description: Search contacts edited from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[changedOn][to] + in: query + description: Search contacts edited to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[email] + in: query + description: Sort by email + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[changedOn] + in: query + description: Sort by change date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[campaignId] + in: query + description: Sort by campaign ID + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: additionalFlags + in: query + description: >- + The additional flags parameter with the value 'exactMatch' will + search for contacts with the exact value of the email and name + provided in the query string. Without this flag, matching is done + via a standard 'like' comparison, which may sometimes be slow. + required: false + schema: + type: string + x-set: + - exactMatch + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ContactList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Contacts + summary: Create a new contact + operationId: createContact + requestBody: + $ref: '#/components/requestBodies/NewContact' + responses: + '202': + description: >- + > + + If the request is successful, the API returns the HTTP code **202 + Accepted**. + + This means that the contact has been preliminarily validated and + added to the queue. + + It may take a few minutes to process the queue and add the contact + to the list. If your contact didn't appear on the list, there's a + possibility that it was rejected at a later stage of processing. + + + ### Double opt-in + + + Campaigns can be set to double opt-in. + + This means that the contact has to click a link in a confirmation + message before they can be added to your list. + + Unconfirmed contacts are not returned by the API and can only be + found using Search Contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /contacts/batch: + post: + tags: + - Contacts + summary: Create multiple contacts at once + description: >- + This endpoint lets you create multiple contacts in one request. + + + **Note** + + + This endpoint is subject to special limits and throttling. You can make + 80 calls per time frame (10 minutes). The allowed batch size is 1000 + contacts. For more information, check our [API + Docs](https://apidocs.getresponse.com/v3/case-study/adding-batch-contacts). + operationId: createBatchContacts + requestBody: + content: + application/json: + schema: + required: + - campaignId + - contacts + properties: + campaignId: + description: ID of the destination campaign (list). + type: string + example: C + contacts: + description: Contacts that will be created. + type: array + items: + required: + - email + properties: + email: + type: string + format: email + example: john.doe@example.com + name: + type: string + maxLength: 128 + minLength: 1 + example: John Doe + dayOfCycle: + description: The day a contact is on in an autoresponder cycle. + type: string + example: '42' + scoring: + description: Contact's score + type: number + example: 8 + ipAddress: + description: >- + Contact's IP address. IPv4 and IPv6 formats are + accepted. + example: 1.2.3.4 + oneOf: + - type: string + format: ipv4 + - type: string + format: ipv6 + tags: + required: + - ids + properties: + ids: + description: List of tag IDs. + type: array + items: + type: string + example: kL6Nh + type: object + customFieldValues: + type: array + items: + required: + - customFieldId + - value + properties: + customFieldId: + description: Custom field ID. + type: string + example: kL6Nh + value: + type: array + items: + type: string + example: 18-35 + type: object + type: object + type: object + responses: + '202': + description: >- + > + + If the request is successful, the API returns the HTTP code **202 + Accepted**. + + This means that the contacts has been preliminarily validated and + added to the queue. + + It may take a few minutes to process the queue and add the contacts + to the list. If your contact doesn't appear on the list, they were + likely rejected during the late processing stages. + + + ### Double opt-in + + + Campaigns (lists) can be set to use double opt-in. + + This means that a contact has to click a link in a confirmation + message before they can be added to your list. + + Unconfirmed contacts are not returned by API and can only be found + using Search Contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /search-contacts: + get: + tags: + - Search Contacts + summary: Get a saved search contact list + description: >- + Makes it possible to retrieve a collection of short representations of + search-contact (known as custom filters in the panel). Every item + represents a basic filter object. You can filter the resource using + criteria specified as `query[*]`. You can provide multiple criteria, to + use AND logic. You can sort the resource using parameters specified as + `sort[*]`. You can specify multiple fields to sort by. + operationId: getSearchContactsList + parameters: + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - name: sort[createdOn] + in: query + description: Sort by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: asc + - name: query[name] + in: query + description: Search by name + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/BaseSearchContactsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Search Contacts + summary: Create search contacts + description: >- + Makes it possible to create a new search-contact. Please refer to + [Segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual) + operationId: newSearchContacts + requestBody: + $ref: '#/components/requestBodies/NewSearchContacts' + responses: + '201': + $ref: '#/components/responses/SearchContactsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /search-contacts/contacts: + post: + tags: + - Search Contacts + summary: Search contacts using conditions + description: >- + Makes it possible to get a collection of contacts according to a given + condition. Please refer to [Segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual) + operationId: getContactsFromSearchContactsConditions + parameters: + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - name: sort[email] + in: query + description: Sort by email + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - name: sort[createdOn] + in: query + description: Sort by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: asc + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + requestBody: + $ref: '#/components/requestBodies/SearchContactsConditionsDetails' + responses: + '200': + $ref: '#/components/responses/SearchedContactsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetContactsBySearchContactsConditions + /transactional-emails/templates: + get: + tags: + - Transactional Emails Templates + summary: Get the list of transactional email templates + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getTransactionalEmailsTemplatesList + parameters: + - name: query[subject] + in: query + description: Search templates by subject + required: false + schema: + type: string + - name: sort[createdOn] + in: query + description: Sort by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subject] + in: query + description: Sort by template subject + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailsTemplateList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + post: + tags: + - Transactional Emails Templates + summary: Create transactional email template + description: This method creates a new transactional email template + operationId: createTransactionalEmailTemplate + requestBody: + $ref: '#/components/requestBodies/CreateTransactionalEmailTemplate' + responses: + '201': + $ref: '#/components/responses/TransactionalEmailsTemplateDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /transactional-emails: + get: + tags: + - Transactional Emails + summary: Get the list of transactional emails + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getTransactionalEmailsList + parameters: + - name: query[sentOn][from] + in: query + description: Search transactional emails sent from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[sentOn][to] + in: query + description: Search transactional emails sent to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[tagged] + in: query + description: Search tagged/untagged transactional emails + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - name: query[tagId] + in: query + description: Search transactional emails with a specific tag ID + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + post: + tags: + - Transactional Emails + summary: Send transactional email + operationId: createTransactionalEmail + requestBody: + $ref: '#/components/requestBodies/CreateTransactionalEmail' + responses: + '201': + $ref: '#/components/responses/TransactionalEmail' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /transactional-emails/statistics: + get: + tags: + - Transactional Emails + summary: Get the overall statistics of transactional emails + operationId: getTransactionalEmailsStatistics + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: true + schema: + type: string + enum: + - total + - day + - name: query[timeFrame][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[timeFrame][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[tagged] + in: query + description: Search tagged/untagged transactional emails + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - name: query[tagId] + in: query + description: Search transactional emails with a specific tag ID + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailStatistics' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /from-fields: + get: + tags: + - From Fields + summary: Get the list of 'From' addresses + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getFromFieldList + parameters: + - name: query[email] + in: query + description: Search 'From' address by email + required: false + schema: + type: string + - name: query[name] + in: query + description: Search 'From' address by name + required: false + schema: + type: string + format: date + - name: query[isDefault] + in: query + description: Search only default 'From' address + required: false + schema: + type: boolean + example: true + - name: query[isActive] + in: query + description: Search only active 'From' addresses + required: false + schema: + type: boolean + example: true + - name: sort[createdOn] + in: query + description: Sort 'From' address by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FromFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - From Fields + summary: Create 'From' address + operationId: createFromField + requestBody: + $ref: '#/components/requestBodies/NewFromField' + responses: + '201': + $ref: '#/components/responses/FromFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /rss-newsletters: + get: + tags: + - RSS Newsletters + summary: Get the list of RSS newsletters + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getRssNewslettersList + parameters: + - name: query[subject] + in: query + description: Search RSS newsletters by subject + required: false + schema: + type: string + - name: query[status] + in: query + description: Search RSS newsletters by status + required: false + schema: + type: string + enum: + - enabled + - disabled + - name: query[createdOn][from] + in: query + description: Search RSS newsletters created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search RSS newsletters created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[campaignId] + in: query + description: Search RSS newsletters by campaign ID + required: false + schema: + type: string + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/RssNewsletterList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - RSS Newsletters + summary: Create RSS newsletter + operationId: createRssNewsletter + requestBody: + $ref: '#/components/requestBodies/NewRssNewsletter' + responses: + '201': + $ref: '#/components/responses/RssNewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /rss-newsletters/statistics: + get: + tags: + - RSS Newsletters + summary: The statistics for all RSS newsletters + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getRssNewsletterStatisticsCollection + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[rssNewsletterId] + in: query + description: The list of RSS newsletter resource IDs (string separated with ',') + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: The list of campaign resource IDs (string separated with ',') + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetRssNewslettersStatistics + /custom-events: + get: + tags: + - Custom Events + summary: Get a list of custom events + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getCustomEventsList + parameters: + - name: query[name] + in: query + description: Search custom events by name + required: false + schema: + type: string + - name: query[hasAttributes] + in: query + description: Search custom events with or without attributes + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CustomEventsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Custom Events + summary: Create custom event + operationId: createCustomEvent + requestBody: + $ref: '#/components/requestBodies/NewCustomEvent' + responses: + '201': + $ref: '#/components/responses/CustomEventDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /custom-events/trigger: + post: + tags: + - Custom Events + summary: Trigger a custom event + operationId: triggerCustomEvent + requestBody: + $ref: '#/components/requestBodies/TriggerCustomEvent' + responses: + '201': + description: Empty response + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: TriggerCustomEvent + /forms: + get: + tags: + - Forms + summary: Get the list of forms. + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getFormList + parameters: + - name: query[name] + in: query + description: Search forms by name + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search forms created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search forms created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[campaignId] + in: query + description: >- + Search forms assigned to this list (campaign). You can pass multiple + comma-separated values, eg. `Xd1P,sC7r` + required: false + schema: + type: string + - name: query[status] + in: query + description: >- + Search by status. **Note:** `disabled` includes both `unpublished` + and `draft` and `enabled` equals `published` + required: false + schema: + type: string + enum: + - enabled + - disabled + - published + - unpublished + - draft + - name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[visitors] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[uniqueVisitors] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subscribed] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subscriptionRate] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FormList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /landing-pages: + get: + tags: + - Legacy Landing Pages + summary: Get a list of landing pages + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getLandingPageList + parameters: + - name: query[domain] + in: query + description: Search landing pages by domain + required: false + schema: + type: string + - name: query[status] + in: query + description: Search landing pages by status + required: false + schema: + $ref: '#/components/schemas/StatusEnum' + - name: query[subdomain] + in: query + description: Search landing pages by subdomain + required: false + schema: + type: string + - name: query[metaTitle] + in: query + description: Search landing pages by metaTitle field + required: false + schema: + type: string + - name: query[userDomain] + in: query + description: Search landing pages by user provided domain + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: >- + Search landing pages by ID of the assigned campaign. Campaign ID + must be encoded! You can get the campaign list with encoded IDs by + calling the `/v3/campaigns` endpoint. You can search by multiple + comma separated values eg. `o5lx,34er`. + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Show landing pages created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Show landing pages created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[domain] + in: query + description: Sort by domain + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[campaignId] + in: query + description: Sort by campaign + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[metaTitle] + in: query + description: Sort by metaTitle + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/LandingPageList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /imports: + get: + tags: + - Imports + summary: Get a list of imports. + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getImportList + parameters: + - name: query[campaignId] + in: query + description: Search imports by campaignId + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search imports created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search imports created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort imports by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[finishedOn] + in: query + description: Sort imports by finish date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[campaignName] + in: query + description: Sort imports by campaign name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[uploadedContacts] + in: query + description: Sort imports by uploaded contact count + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[updatedContacts] + in: query + description: Sort imports by updated contact count + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[addedContacts] + in: query + description: Sort imports by inserted contact count + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[invalidContacts] + in: query + description: Sort imports by invalid contact count + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[status] + in: query + description: >- + Sort imports by status (uploaded, to_review, approved, finished, + rejected, canceled) + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ImportList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Imports + summary: Schedule a new contact import + description: >- + This endpoint lets you schedule a contact import. That way, you can add + and update your contacts using a single API call. Since API imports are + asynchronous, you should check periodically for updates while your + original API request is being processed. To keep track of your import + status, use [GET + import](https://apireference.getresponse.com/#operation/getImportById) + (provide the importId from the response), or subscribe to an [import + finished](https://apidocs.getresponse.com/v3/payloads#contacts-import-finished) + webhook. For more information on imports, check our [API + Docs](https://apidocs.getresponse.com/v3/case-study/create-import) or + [Help + Center](https://www.getresponse.com/help/how-do-i-prepare-a-file-for-import.html) + operationId: createImport + requestBody: + $ref: '#/components/requestBodies/NewImport' + responses: + '201': + $ref: '#/components/responses/ImportDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /statistics/ecommerce/revenue: + get: + tags: + - Ecommerce + summary: Get the ecommerce revenue statistics + operationId: getRevenueStats + parameters: + - name: query[orderDate][from] + in: query + description: Show statistics for orders from this date + required: false + schema: + type: string + format: date + - name: query[orderDate][to] + in: query + description: Show statistics for orders to this date + required: false + schema: + type: string + format: date + - name: query[shopId] + in: query + description: >- + Search statistics by shop ID. You can get the shop ID by calling the + `/v3/shops` endpoint. You can search for multiple shops using + comma-separated values, for example, `pgIH, CNXF` + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/RevenueStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /statistics/ecommerce/performance: + get: + tags: + - Ecommerce + summary: Get the ecommerce general performance statistics + operationId: getGeneralPerformanceStats + parameters: + - name: query[orderDate][from] + in: query + description: Show statistics for orders from this date + required: false + schema: + type: string + format: date + - name: query[orderDate][to] + in: query + description: Show statistics for orders to this date + required: false + schema: + type: string + format: date + - name: query[shopId] + in: query + description: >- + Search statistics by shop ID. You can get the shop ID by calling the + `/v3/shops` endpoint. You can search for multiple shops using + comma-separated values, for example, `pgIH, CNXF` + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/GeneralPerformanceStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /predefined-fields: + get: + tags: + - Predefined Fields + summary: Get the predefined fields list + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getPredefinedFieldList + parameters: + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: DESC + - name: query[name] + in: query + description: Search by name + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: Search by campaign ID + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/PredefinedFieldsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Predefined Fields + summary: Create a predefined field + description: Makes it possible to create a new predefined field. + operationId: createPredefinedField + requestBody: + $ref: '#/components/requestBodies/NewPredefinedField' + responses: + '201': + $ref: '#/components/responses/PredefinedFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /suppressions: + get: + tags: + - Suppressions + summary: Get suppression lists + operationId: getSuppressionsList + parameters: + - name: query[name] + in: query + description: Search suppressions by name + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search suppressions created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search suppressions created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by the createdOn date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SuppressionsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Suppressions + summary: Creates a new suppression list + operationId: createSuppression + requestBody: + description: The suppression list to be added. + $ref: '#/components/requestBodies/NewSuppression' + responses: + '201': + $ref: '#/components/responses/SuppressionDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /subscription-confirmations/body/{languageCode}: + get: + tags: + - Subscription Confirmations + summary: Get collection of SUBSCRIPTION CONFIRMATIONS bodies + description: >+ + + Sending **GET** request to this url, returns collection of + **SUBSCRIPTION CONFIRMATIONS** bodies. + + + Language code used in url must be in ISO 639-1 Language Code Standard. + + operationId: getSubscriptionConfirmationBodyList + parameters: + - $ref: '#/components/parameters/languageCode' + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SubscriptionConfirmationBodyList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /subscription-confirmations/subject/{languageCode}: + get: + tags: + - Subscription Confirmations + summary: Get collection of SUBSCRIPTION CONFIRMATIONS subjects + description: >+ + + Sending **GET** request to this url, returns collection of + **SUBSCRIPTION CONFIRMATIONS** subjects. + + + Language code used in url must be in ISO 639-1 Language Code Standard. + + operationId: getSubscriptionConfirmationSubjectList + parameters: + - $ref: '#/components/parameters/languageCode' + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SubscriptionConfirmationSubjectList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /shops: + get: + tags: + - Shops + summary: Get a list of shops + description: >- + + Sending a **GET** request to this URL returns a collection of shop + resources. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + + The `name` fields can be a pattern and we'll try to match this phrase. + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getShopList + parameters: + - name: query[name] + in: query + description: Search shop by name + required: false + schema: + type: string + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ShopList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Shops + summary: Create shop + description: |+ + + This method makes it possible to create a new shop. + + operationId: createShop + requestBody: + $ref: '#/components/requestBodies/NewShop' + responses: + '201': + $ref: '#/components/responses/ShopDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /popups: + get: + tags: + - Forms and Popups + summary: Get the list of forms and popups + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getPopupsList + parameters: + - name: query[name] + in: query + description: Search forms and popups by name + required: false + schema: + type: string + - name: query[status] + in: query + description: Search forms and popups by status + required: false + schema: + type: string + enum: + - published + - unpublished + - name: stats[from] + in: query + description: Show statistics from this date + required: false + schema: + type: string + format: date-time + - name: stats[to] + in: query + description: Show statistics to this date + required: false + schema: + type: string + format: date-time + - name: sort[name] + in: query + description: Sort forms and popups by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[status] + in: query + description: Sort forms and popups by status + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdAt] + in: query + description: Sort forms and popups by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[updatedAt] + in: query + description: Sort forms and popups by modification date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[views] + in: query + description: Sort by number of views + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[uniqueVisitors] + in: query + description: Sort by number of unique visitors + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[leads] + in: query + description: Sort by number of leads + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[ctr] + in: query + description: Sort by CTR (click-through rate) + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/PopupsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /splittests: + get: + tags: + - A/B tests + summary: The list of A/B tests. + description: >- + The list of A/B tests. You can filter the resource using criteria + specified as `query[*]`. You can provide multiple criteria, to use AND + logic. You can sort the resource using parameters specified as + `sort[*]`. You can specify multiple fields to sort by. + operationId: getSplittestList + parameters: + - name: query[name] + in: query + description: Search A/B tests by name + required: false + schema: + type: string + - name: query[type] + in: query + description: Search A/B tests by type + required: false + schema: + type: string + - name: query[status] + in: query + description: Search A/B tests by status + required: false + schema: + type: string + default: active + enum: + - active + - inactive + - name: query[createdOn][from] + in: query + description: Search A/B tests created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search A/B tests created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SplittestList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /file-library/quota: + get: + tags: + - File Library + summary: Get storage space information + operationId: quota + responses: + '200': + $ref: '#/components/responses/Quota' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /file-library/files: + get: + tags: + - File Library + summary: Get the list of files + description: >- + By default, you can only search files in the root directory. To search + for files in all folders, use the parameter `query[allFolders]=true`. To + search for files in a specified folder, use the parameter + `query[folderId]=`. **Note: these two parameters can't be used + together**. You can filter the resource using criteria specified as + `query[*]`. You can provide multiple criteria, to use AND logic. You can + sort the resource using parameters specified as `sort[*]`. You can + specify multiple fields to sort by. + operationId: getFileList + parameters: + - name: query[allFolders] + in: query + description: >- + Return files from all folders, including the root folder. **This + parameter can't be used together with ** `query[folderId]` + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - name: query[folderId] + in: query + description: >- + Search for files in a specific folder. **This parameter can't be + used together with ** `query[allFolders]` + required: false + schema: + type: string + - name: query[name] + in: query + description: Search for files by name + required: false + schema: + type: string + - name: query[group] + in: query + description: Search for files by group + required: false + schema: + $ref: '#/components/schemas/FileGroup' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[group] + in: query + description: Sort files by group + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[size] + in: query + description: Sort files by size + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FileList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - File Library + summary: Create a file + operationId: createFile + requestBody: + $ref: '#/components/requestBodies/NewFile' + responses: + '201': + $ref: '#/components/responses/File' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /file-library/folders: + get: + tags: + - File Library + summary: Get the list of folders + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getFolderList + parameters: + - name: query[name] + in: query + description: Search folders by name + required: false + schema: + type: string + - name: sort[name] + in: query + description: Sort folders by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[size] + in: query + description: Sort folders by size + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort folders by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FoldersList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - File Library + summary: Create a folder + operationId: createFolder + requestBody: + $ref: '#/components/requestBodies/NewFolder' + responses: + '201': + $ref: '#/components/responses/Folder' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /ab-tests/subject: + get: + tags: + - A/B tests - subject + summary: The list of A/B tests + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: AbtestsSubjectGetList + parameters: + - name: query[name] + in: query + description: Search A/B tests by name + required: false + schema: + type: string + - name: query[stage] + in: query + description: Search A/B tests by stage + required: false + schema: + type: string + enum: + - preparing + - testing + - finished + - sending-winner + - cancelled + - draft + - completed + - name: query[abTestId] + in: query + description: Search A/B tests by ID + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: Search A/B tests by list ID + required: false + schema: + type: string + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[stage] + in: query + description: Sort by stage + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[sendOn] + in: query + description: Sort by send date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[totalDelivered] + in: query + description: Sort by total delivered + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AbtestsSubjectGetList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - A/B tests - subject + summary: Create a new A/B test + operationId: postAbtestsSubjectById + requestBody: + $ref: '#/components/requestBodies/NewAbtestsSubject' + responses: + '201': + $ref: '#/components/responses/AbtestsSubjectGetDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /click-tracks: + get: + tags: + - Click Tracks + summary: Get click tracked links list + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getClickTrackList + parameters: + - name: query[createdOn][from] + in: query + description: Search click tracks from messages created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search click tracks from messages created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort by message date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ClickTrackList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /newsletters: + get: + tags: + - Newsletters + summary: Get the newsletter list + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getNewsletterList + parameters: + - name: query[subject] + in: query + description: Search newsletters by subject + required: false + schema: + type: string + - name: query[name] + in: query + description: Search newsletters by name + required: false + schema: + type: string + - name: query[status] + in: query + description: Search newsletters by status + required: false + schema: + type: string + enum: + - enabled + - disabled + - name: query[createdOn][from] + in: query + description: Search newsletters created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search newsletters created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[sendOn][from] + in: query + description: Search for newsletters sent from this date + required: false + schema: + type: string + format: date + example: '2023-01-20' + - name: query[sendOn][to] + in: query + description: Search for newsletters sent to this date + required: false + schema: + type: string + format: date + example: '2023-01-20' + - name: query[type] + in: query + description: Search newsletters by type + required: false + schema: + type: string + enum: + - draft + - broadcast + - splittest + - automation + - name: query[campaignId] + in: query + description: Search newsletters by campaign ID + required: false + schema: + type: string + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[sendOn] + in: query + description: Sort by send on date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/NewsletterList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Newsletters + summary: Create newsletter + description: | + > + This method creates a new newsletter and puts it in a queue to send. + + **NOTE: This method has a limit of 256 calls per day.** + operationId: createNewsletter + requestBody: + $ref: '#/components/requestBodies/NewNewsletter' + responses: + '201': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /newsletters/send-draft: + post: + tags: + - Newsletters + summary: Send the newsletter draft + operationId: sendDraft + requestBody: + $ref: '#/components/requestBodies/SendNewsletterDraft' + responses: + '201': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: SendNewsletterDraft + /newsletters/statistics: + get: + tags: + - Newsletters + summary: Total newsletter statistics + description: >- + >This makes it possible to fetch newsletter statistics based on the list + of campaign or newsletter IDs + + (you can pass them in the query parameter - see the description below). + Remember that all the statistics date ranges + + are returned in standard UTC period type objects. ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)). You + can filter the resource using criteria specified as `query[*]`. You can + provide multiple criteria, to use AND logic. You can sort the resource + using parameters specified as `sort[*]`. You can specify multiple fields + to sort by. + operationId: getNewsletterStatisticsCollection + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[newsletterId] + in: query + description: The list of newsletter resource IDs (string separated with '') + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: The list of campaign resource IDs (string separated with '') + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /tags: + get: + tags: + - Tags + summary: Get the list of tags + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getTagsList + parameters: + - name: query[name] + in: query + description: Search tags by name + required: false + schema: + type: string + - name: query[createdAt][from] + in: query + description: Search tags created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdAt][to] + in: query + description: Search tags created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdAt] + in: query + description: Sort tags by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TagList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Tags + summary: Add a new tag + operationId: createTag + requestBody: + $ref: '#/components/requestBodies/NewTag' + responses: + '201': + $ref: '#/components/responses/TagDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /addresses: + get: + tags: + - Addresses + summary: Get a list of addresses + description: >- + + Sending a **GET** request to this URL returns collection of address + resources. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + + * firstName + + * lastName + + * address1 + + * address2 + + * city + + * zip + + * province + + * provinceCode + + * phone + + * company + + * createdOn + + + The `name` field can be a pattern and we'll try to match this phrase. + + + You can specify which page of the results you want and how many results + per page to display. You can also specify the sort-order using one or + more of the allowed fields (listed below in the request params section). + + + Last but not least, you can even specify which fields from a resource + you want to get. If you pass the param `fields` with the list of fields + (separated by a comma [,]) we'll return the list of resources with only + those fields (we'll always add a resource ID to ensure that you can use + that data later on) + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getAddressList + parameters: + - name: query[name] + in: query + description: Search addresses by name + required: false + schema: + type: string + - name: query[firstName] + in: query + description: Search addresses by first name + required: false + schema: + type: string + - name: query[lastName] + in: query + description: Search addresses by last name + required: false + schema: + type: string + - name: query[address1] + in: query + description: Search addresses by address1 field + required: false + schema: + type: string + - name: query[address2] + in: query + description: Search addresses by address2 field + required: false + schema: + type: string + - name: query[city] + in: query + description: Search addresses by city + required: false + schema: + type: string + - name: query[zip] + in: query + description: Search addresses by ZIP + required: false + schema: + type: string + - name: query[province] + in: query + description: Search addresses by province + required: false + schema: + type: string + - name: query[provinceCode] + in: query + description: Search addresses by province code + required: false + schema: + type: string + - name: query[phone] + in: query + description: Search addresses by phone + required: false + schema: + type: string + - name: query[company] + in: query + description: Search addresses by company + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search addresses created from this date + required: false + schema: + type: string + format: date-time + - name: query[createdOn][to] + in: query + description: Search addresses created to this date + required: false + schema: + type: string + format: date-time + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AddressList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Addresses + summary: Create address + description: '' + operationId: createAddress + requestBody: + $ref: '#/components/requestBodies/NewAddress' + responses: + '201': + $ref: '#/components/responses/AddressDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/blocklists: + get: + tags: + - Accounts + summary: Returns account blocklist masks + operationId: getAccountBlocklist + parameters: + - name: query[mask] + in: query + description: Blocklist mask to search for + required: false + schema: + type: string + example: '@somedomain.com' + responses: + '200': + $ref: '#/components/responses/AccountBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Accounts + summary: Update account blocklist + operationId: updateAccountBlocklist + parameters: + - name: additionalFlags + in: query + description: >- + The flag value `add` adds the masks provided in the request body to + your blocklist. The flag value `delete` deletes the masks. The masks + are replaced if there are no flag values in the request body. + + For better performance, use the flag value `noResponse`. It removes the response body and can be used alone or combined with other flags. If multiple flags are used, separate them by a comma, like this: `additionalFlags=noResponse` or `additionalFlags=add,noResponse`. + required: false + schema: + type: string + enum: + - add + - delete + - noResponse + requestBody: + $ref: '#/components/requestBodies/UpdateAccountBlocklist' + responses: + '200': + $ref: '#/components/responses/AccountBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: update + /custom-fields: + get: + tags: + - Custom Fields + summary: Get a list of custom fields + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getCustomFieldList + parameters: + - name: query[name] + in: query + description: Search custom fields by name + required: false + schema: + type: string + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CustomFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Custom Fields + summary: Create a custom field + operationId: createCustomField + requestBody: + $ref: '#/components/requestBodies/NewCustomField' + responses: + '201': + $ref: '#/components/responses/CustomFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /lps: + get: + tags: + - Landing Pages + summary: Get the list of landing pages + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getLpsList + parameters: + - name: query[name] + in: query + description: Search landing pages by name + required: false + schema: + type: string + - name: query[status] + in: query + description: Search landing pages by status + required: false + schema: + type: string + enum: + - published + - unpublished + - name: stats[from] + in: query + description: Show statistics for landing pages from this date + required: false + schema: + type: string + format: date-time + - name: stats[to] + in: query + description: Show statistics for landing pages to this date + required: false + schema: + type: string + format: date-time + - name: sort[name] + in: query + description: Sort landing pages by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdAt] + in: query + description: Sort landing pages by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[updatedAt] + in: query + description: Sort landing pages by modification date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[visits] + in: query + description: Sort by number of page visits + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[leads] + in: query + description: Sort landing pages by number of leads + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subscriptionRate] + in: query + description: Sort by subscription rate + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/LpsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /multimedia: + get: + tags: + - Multimedia + summary: Get images list + operationId: getImageList + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ImageList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Multimedia + summary: Upload image + operationId: uploadImage + requestBody: + $ref: '#/components/requestBodies/CreateMultimedia' + responses: + '200': + $ref: '#/components/responses/ImageDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: CreateMultimedia + x-type: upload + /tracking: + get: + tags: + - Tracking + summary: Get Tracking JavaScript code snippets + description: >- + With code snippets you will be able to track Purchases, Abandoned carts, + and Visited URLs. Find more in our [Help + Center](https://www.getresponse.com/help/marketing-automation/ecommerce-conditions/how-do-i-add-the-tracking-javascript-code-to-my-website.html). + operationId: getTracking + responses: + '200': + $ref: '#/components/responses/Tracking' + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /tracking/facebook-pixels: + get: + tags: + - Tracking + summary: Get the list of "Facebook Pixels" + description: >- + Returns the name and ID of "Facebook Pixels" assigned to a user's + account. + operationId: getFacebookPixelList + responses: + '200': + $ref: '#/components/responses/FacebookPixelList' + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts: + get: + tags: + - Accounts + summary: Account information + operationId: getAccount + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AccountDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Accounts + summary: Update account + operationId: updateAccount + requestBody: + $ref: '#/components/requestBodies/UpdateAccount' + responses: + '200': + $ref: '#/components/responses/AccountDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: UpdateAccount + /accounts/billing: + get: + tags: + - Accounts + summary: Billing information + operationId: getAccountBilling + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AccountBillingDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/login-history: + get: + tags: + - Accounts + summary: History of logins + operationId: getAccountLoginHistory + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AccountLoginHistoryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/badge: + get: + tags: + - Accounts + summary: Current status of your GetResponse badge + operationId: getAccountBadge + responses: + '200': + $ref: '#/components/responses/AccountBadgeDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Accounts + summary: Turn on/off the GetResponse Badge + operationId: updateAccountBadge + requestBody: + $ref: '#/components/requestBodies/UpdateAccountBadge' + responses: + '200': + $ref: '#/components/responses/AccountBadgeDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: update + /accounts/industries: + get: + tags: + - Accounts + summary: List of Industry Tags + description: List of Industry Tags in account's language context. + operationId: getIndustries + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/IndustryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/timezones: + get: + tags: + - Accounts + summary: List of timezones + description: List of timezones in account's language context. + operationId: getTimezones + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AccountTimezoneList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/callbacks: + get: + tags: + - Accounts + summary: Get callbacks configuration + operationId: getCallbacks + responses: + '200': + $ref: '#/components/responses/Callback' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Callbacks are disabled for the account + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Accounts + summary: Enable or update callbacks configuration + operationId: updateCallbacks + requestBody: + $ref: '#/components/requestBodies/UpdateCallbacks' + responses: + '200': + $ref: '#/components/responses/Callback' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: UpdateCallback + delete: + tags: + - Accounts + summary: Disable callbacks + operationId: disableCallbacks + responses: + '204': + description: Empty response + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/sending-limits: + get: + tags: + - Accounts + summary: Send limits + operationId: getSendingLimits + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SendingLimitsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /campaigns: + get: + tags: + - Campaigns (Lists) + summary: Get a list of campaigns + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getCampaignList + parameters: + - name: query[name] + in: query + required: false + schema: + type: string + example: campaign_name + - name: query[isDefault] + in: query + required: false + schema: + type: boolean + example: true + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CampaignList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Campaigns (Lists) + summary: Create a campaign + operationId: createCampaign + requestBody: + $ref: '#/components/requestBodies/NewCampaign' + responses: + '201': + $ref: '#/components/responses/Campaign' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /campaigns/statistics/origins: + get: + tags: + - Campaigns (Lists) + summary: Get subscriber origin statistics + description: The results are indexed with the campaign ID. + operationId: getCampaignStatisticsOrigins + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/CampaignOriginsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsOrigins + /campaigns/statistics/locations: + get: + tags: + - Campaigns (Lists) + summary: Get subscriber location statistics + description: The results are indexed with the location name (PL, EN, etc.). + operationId: getCampaignStatisticsLocations + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/CampaignLocationsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsLocations + /campaigns/statistics/list-size: + get: + tags: + - Campaigns (Lists) + summary: Get campaign size statistics + description: >- + Returns the number of the total added and removed subscribers, grouped + by default or by time period. + operationId: getCampaignStatisticsListSize + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/CampaignListSizesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsListSize + /campaigns/statistics/subscriptions: + get: + tags: + - Campaigns (Lists) + summary: Get the number and origin of subscription statistics + description: >- + Returns the number and origin of subscriptions, grouped by a specified + campaigns for each day on which any changes were made. Dates in the + YYYY-MM-DD format are used as keys in the response. + operationId: getCampaignStatisticsSubscriptions + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/SubscriptionsByDatesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsSubscriptions + /campaigns/statistics/removals: + get: + tags: + - Campaigns (Lists) + summary: Get removal statistics + description: >- + Returns the number and reason for removed contacts. Dates in the + YYYY-MM-DD format are used as keys in the response. + operationId: getCampaignStatisticsRemovals + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/RemovalsByDatesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsRemovals + /campaigns/statistics/balance: + get: + tags: + - Campaigns (Lists) + summary: Get balance statistics + description: >- + Returns the balance of subscriptions. Dates in the YYYY-MM-DD format are + used as keys in the response. + operationId: getCampaignStatisticsBalance + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/BalanceByDatesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsBalance + /campaigns/statistics/summary: + get: + tags: + - Campaigns (Lists) + summary: Get the statistics summary for selected campaigns + description: The results are indexed with the campaign ID. + operationId: getCampaignStatisticsSummary + parameters: + - name: query[campaignId] + in: query + required: false + schema: + $ref: '#/components/schemas/CampaignStatisticsIdQuery' + responses: + '200': + $ref: '#/components/responses/CampaignSummaryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsSummary + /webforms: + get: + tags: + - Legacy Forms + summary: Get Legacy Forms. + description: >- + Get the list of Legacy Forms. You can filter the resource using criteria + specified as `query[*]`. You can provide multiple criteria, to use AND + logic. You can sort the resource using parameters specified as + `sort[*]`. You can specify multiple fields to sort by. + operationId: getLegacyFormList + parameters: + - name: query[name] + in: query + description: Search Legacy Forms by name + required: false + schema: + type: string + - name: query[modifiedOn][from] + in: query + description: Search Legacy Forms modified from this date + required: false + schema: + type: string + format: date-time + - name: query[modifiedOn][to] + in: query + description: Search Legacy Forms modified to this date + required: false + schema: + type: string + format: date-time + - name: query[campaignId] + in: query + description: >- + Search Legacy Forms by campaignId. Accepts multiple IDs separated + with a comma + required: false + schema: + type: string + - name: sort[modifiedOn] + in: query + description: Sort Legacy Forms by modification date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/LegacyFormList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /gdpr-fields: + get: + tags: + - GDPR Fields + summary: Get the GDPR fields list + operationId: getGDPRFieldList + parameters: + - name: sort[name] + in: query + description: Sort fields by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort fields by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/GDPRFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /workflow: + get: + tags: + - Workflows + summary: Get workflows + description: Get the list of workflows. + operationId: getWorkflowList + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/WorkflowList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetWorkflows + /sms-automation: + get: + tags: + - SMS Automation Messages + summary: Get the list of automated SMS messages. + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getSMSAutomationList + parameters: + - name: query[name] + in: query + description: Search automated SMS messages by name + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: Search automated SMS messages by campaign (list) ID + required: false + schema: + type: string + - name: query[hasLinks] + in: query + description: Search for automated SMS messages containing links + required: false + schema: + type: boolean + - name: sort[status] + in: query + description: Sort by the status of the SMS message + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + description: Sort by the name of the automated SMS message + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[modifiedOn] + in: query + description: Sort by the date the SMS message was modified on + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[delivered] + in: query + description: Sort by the number of delivered SMS messages + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[sent] + in: query + description: Sort by the number of sent SMS messages + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[clicks] + in: query + description: Sort by the number of link clicks + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SmsAutomationList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /sms: + get: + tags: + - SMS Messages + summary: Get the list of SMS messages. + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getSMSList + parameters: + - name: query[type] + in: query + description: Search SMS messages by type + required: false + schema: + type: string + enum: + - sms + - draft + - name: query[name] + in: query + description: Search SMS messages by name + required: false + schema: + type: string + - name: query[sendingStatus] + in: query + description: Search SMS messages by status + required: false + schema: + type: string + enum: + - scheduled + - sending + - sent + - name: query[campaignId] + in: query + description: Search SMS messages by campaign (list) ID + required: false + schema: + type: string + - name: query[hasLinks] + in: query + description: Search for SMS messages with links + required: false + schema: + type: boolean + - name: sort[sendingStatus] + in: query + description: Sort by sending status + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[sendOn] + in: query + description: Sort by sending date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[modifiedOn] + in: query + description: Sort by modification date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[delivered] + in: query + description: Sort by number of delivered messages + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[sent] + in: query + description: Sort by number of sent messages + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[clicks] + in: query + description: Sort by number of link clicks + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SmsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /autoresponders: + get: + tags: + - Autoresponders + summary: Get the list of autoresponders. + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getAutoresponderList + parameters: + - name: query[subject] + in: query + description: Search autoresponder by subject + required: false + schema: + type: string + - name: query[name] + in: query + description: Search autoresponder by name + required: false + schema: + type: string + - name: query[status] + in: query + description: Search autoresponder by status + required: false + schema: + type: string + enum: + - enabled + - disabled + - name: query[createdOn][from] + in: query + description: Search autoresponder created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search autoresponder created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[campaignId] + in: query + description: Search autoresponder by campaign ID + required: false + schema: + type: string + - name: query[type] + in: query + description: Search autoresponder by type + required: false + schema: + type: string + enum: + - timebase + - actionbase + - name: query[triggerType] + in: query + description: Search autoresponder by triggerType + required: false + schema: + type: string + enum: + - onday + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subject] + in: query + description: Sort by subject + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[dayOfCycle] + in: query + description: Sort by cycle day + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[delivered] + in: query + description: Sort by delivered + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[openRate] + in: query + description: Sort by open rate + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[clickRate] + in: query + description: Sort by click rate + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AutoresponderList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Autoresponders + summary: Create autoresponder + description: > + > + + **The action-based autoresponder feature has been migrated over to + marketing automation. Your existing autoresponders are + + now converted into workflows. You can no longer create and update + action-based autoresponders using our API.** + + + This request allows you to create an autoresponder. Remember to select + the proper `sendSettings` - depending on `type` you need to fill + corresponding setting (eg. if you selected type `delay`, then you MUST + fill `delayInHours` field). + operationId: createAutoresponder + requestBody: + $ref: '#/components/requestBodies/NewAutoresponder' + responses: + '201': + $ref: '#/components/responses/AutoresponderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /autoresponders/statistics: + get: + tags: + - Autoresponders + summary: The statistics for all autoresponders + description: >- + > + + This returns the statistics summary for selected autoresponders. You can + select them by specifying the autoresponder or campaign IDs. + + As in all statistics, you can change the date and time range (hourly + daily monthly or total). Keep in mind + + that all statistics date ranges are given in standard UTC period type + objects. ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)) + + + (https://app.getresponse.com/statistics.html?t=followup#total). + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getAutoresponderStatisticsCollection + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[autoreponderId] + in: query + description: The list of autoresponder resource IDs (string separated with '') + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: The list of campaign resource IDs (string separated with '') + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetAutorespondersStatistics + /websites: + get: + tags: + - Websites + summary: Get the list of websites + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getWebsitesList + parameters: + - name: query[name] + in: query + description: Search websites by name + required: false + schema: + type: string + - name: query[status] + in: query + description: Search websites by status + required: false + schema: + type: string + enum: + - published + - unpublished + - name: stats[from] + in: query + description: Show statistics for websites from this date + required: false + schema: + type: string + format: date-time + - name: stats[to] + in: query + description: Show statistics for websites to this date + required: false + schema: + type: string + format: date-time + - name: sort[name] + in: query + description: Sort websites by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdAt] + in: query + description: Sort websites by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[updatedAt] + in: query + description: Sort websites by modification date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[pageViews] + in: query + description: Sort websites by page views + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[visits] + in: query + description: Sort by number of site visits + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[uniqueVisitors] + in: query + description: Sort by number of unique visitors + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/WebsitesList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all +components: + schemas: + CreateAndUpdate: + properties: + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + updatedOn: + description: The date of the last update + type: string + format: date-time + readOnly: true + type: object + Shop: + properties: + shopId: + description: The shop ID + type: string + readOnly: true + example: pf3 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3 + name: + description: The shop name + type: string + maxLength: 124 + minLength: 4 + example: Monster market + locale: + description: The language locale (ISO 639-1) + type: string + example: PL + currency: + description: The currency code (ISO 4217) + type: string + example: PLN + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + NewShop: + required: + - name + - locale + - currency + type: object + allOf: + - $ref: '#/components/schemas/Shop' + BaseCategory: + properties: + categoryId: + description: The category ID + type: string + readOnly: true + example: atQ + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/categories/atQ + name: + description: The name of the category + type: string + maxLength: 64 + minLength: 2 + example: Headwear + parentId: + description: The parent category ID + type: string + maxLength: 64 + minLength: 2 + example: amh + isDefault: + description: This is a default category + type: boolean + example: true + url: + description: The external URL to the category + type: string + format: uri + maxLength: 2048 + example: https://somedomain.com/category/446 + externalId: + description: >- + The external ID is the identifying string or number of the category + given by another software + type: string + maxLength: 255 + example: ext3343 + type: object + Category: + type: object + allOf: + - $ref: '#/components/schemas/BaseCategory' + - $ref: '#/components/schemas/CreateAndUpdate' + NewCategory: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/Category' + UpdateCategory: + type: object + allOf: + - $ref: '#/components/schemas/Category' + UpdateShop: + type: object + allOf: + - $ref: '#/components/schemas/Shop' + ProductCategory: + type: object + allOf: + - $ref: '#/components/schemas/BaseCategory' + - $ref: '#/components/schemas/CreateAndUpdate' + NewProductCategory: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseCategory' + BaseMetaField: + properties: + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/meta-fields/NoF + metaFieldId: + description: The meta field ID + type: string + readOnly: true + example: NoF + name: + description: The meta field name + type: string + maxLength: 63 + minLength: 3 + example: Shoe size + value: + description: The meta field value + type: string + maxLength: 65000 + minLength: 0 + example: '11' + valueType: + description: The value type enumerable + type: string + enum: + - string + - integer + example: integer + description: + description: The meta field description + type: string + maxLength: 255 + minLength: 0 + example: Description of this meta field + type: object + MetaField: + type: object + allOf: + - $ref: '#/components/schemas/BaseMetaField' + - $ref: '#/components/schemas/CreateAndUpdate' + NewMetaField: + required: + - name + - value + - valueType + type: object + allOf: + - $ref: '#/components/schemas/BaseMetaField' + Product: + properties: + productId: + description: The product ID + type: string + readOnly: true + example: 9I + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/products/9I + name: + description: The product name + type: string + maxLength: 255 + minLength: 2 + example: Monster Cap + type: + description: The product type + type: string + maxLength: 64 + minLength: 2 + example: Headwear + url: + description: The external URL for the product + type: string + format: uri + maxLength: 2048 + example: https://somedomain.com/products/456 + vendor: + description: The product vendor + type: string + maxLength: 64 + minLength: 2 + example: GetResponse + externalId: + description: >- + The external ID is the identifying string or number of the product + given by another software + type: string + maxLength: 255 + example: '123456' + categories: + type: array + items: + $ref: '#/components/schemas/NewProductCategory' + variants: + type: array + items: + $ref: '#/components/schemas/NewProductVariant' + metaFields: + type: array + items: + $ref: '#/components/schemas/NewMetaField' + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + NewProduct: + required: + - name + - variants + type: object + allOf: + - $ref: '#/components/schemas/Product' + UpdateProduct: + type: object + allOf: + - $ref: '#/components/schemas/Product' + UpsertProductCategory: + description: >- + This method makes it possible to assign product categories, and to set a + default product category. It doesn't remove or unassign product + categories. + required: + - categories + properties: + categories: + type: array + items: + $ref: '#/components/schemas/UpsertSingleProductCategory' + type: object + UpsertSingleProductCategory: + required: + - categoryId + properties: + categoryId: + description: The category ID + type: string + example: atQ + isDefault: + description: This is a default category + type: boolean + example: true + type: object + UpsertMetaField: + description: This method assigns metafields. It doesn't unassign or delete them. + required: + - metaFields + properties: + metaFields: + type: array + items: + $ref: '#/components/schemas/UpsertSingleMetaField' + type: object + UpsertSingleMetaField: + required: + - metaFieldId + properties: + metaFieldId: + description: MetaField ID + type: string + example: NoF + type: object + UpdateMetaField: + type: object + allOf: + - $ref: '#/components/schemas/MetaField' + BaseProductVariant: + properties: + variantId: + description: The product ID + type: string + readOnly: true + example: VTB + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/products/9I/variants/VTB + name: + description: The product name + type: string + maxLength: 255 + minLength: 1 + example: Red Monster Cap + url: + description: The external URL to the product variant + type: string + format: uri + maxLength: 2048 + example: https://somedomain.com/products-variants/986 + sku: + description: >- + The stock-keeping unit of a variant. Must be unique within the + product + type: string + maxLength: 255 + minLength: 2 + example: SKU-1254-56-457-5689 + price: + description: The price + type: number + format: double + example: 20 + priceTax: + description: The price including tax + type: number + format: double + example: 27.5 + previousPrice: + description: The price before the change + type: number + format: double + example: 25 + nullable: true + previousPriceTax: + description: The price before the change including tax + type: number + format: double + example: 33.6 + nullable: true + quantity: + description: The quantity of variant items + type: integer + format: int64 + default: 1 + position: + description: The position of a variant + type: integer + format: int64 + example: 1 + barcode: + description: The barcode of a variant + type: string + maxLength: 255 + minLength: 2 + example: '12455687' + externalId: + description: >- + The external ID is the identifying string or number of the variant + given by another software + type: string + maxLength: 255 + example: ext1456 + description: + description: The description of a variant + type: string + maxLength: 1000 + minLength: 2 + example: Red Cap with GetResponse Monster print + images: + type: array + items: + $ref: '#/components/schemas/NewProductVariantImage' + metaFields: + type: array + items: + $ref: '#/components/schemas/NewMetaField' + taxes: + type: array + items: + $ref: '#/components/schemas/NewTax' + type: object + ProductVariant: + type: object + allOf: + - $ref: '#/components/schemas/BaseProductVariant' + - $ref: '#/components/schemas/CreateAndUpdate' + NewProductVariant: + required: + - name + - price + - priceTax + - sku + type: object + allOf: + - $ref: '#/components/schemas/BaseProductVariant' + UpdateProductVariant: + type: object + allOf: + - $ref: '#/components/schemas/ProductVariant' + NewProductVariantImage: + required: + - src + - position + properties: + imageId: + description: The image ID + type: string + readOnly: true + example: hY + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/images/hY + src: + description: The source URL of an image + type: string + format: uri + example: http://somedomain.com/images/src/img58db7ec64bab9.png + position: + description: The position of an image + type: integer + format: int32 + example: '1' + type: object + BaseTax: + properties: + taxId: + description: The tax ID + type: string + readOnly: true + example: Sk + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/taxes/Sk + name: + description: The tax name + type: string + maxLength: 255 + minLength: 2 + example: VAT + rate: + description: The rate value + type: number + format: double + maximum: 99.9 + minimum: 0 + example: 23 + type: object + Tax: + type: object + allOf: + - $ref: '#/components/schemas/BaseTax' + - $ref: '#/components/schemas/CreateAndUpdate' + NewTax: + required: + - name + - rate + type: object + allOf: + - $ref: '#/components/schemas/BaseTax' + UpdateTax: + type: object + allOf: + - $ref: '#/components/schemas/BaseTax' + Address: + properties: + addressId: + type: string + readOnly: true + example: k9 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/addresses/k9 + countryCode: + description: The country code (ISO 3166-1 alpha-3) + type: string + maxLength: 3 + minLength: 3 + example: POL + countryName: + description: The country name, based on `countryCode` + type: string + readOnly: true + example: Poland + name: + type: string + maxLength: 128 + minLength: 3 + example: some_shipping_address + firstName: + type: string + maxLength: 64 + minLength: 0 + example: John + lastName: + type: string + maxLength: 64 + minLength: 0 + example: Doe + address1: + description: Address line 1 + type: string + maxLength: 255 + minLength: 0 + example: Arkonska 6 + address2: + description: Address line 2 + type: string + maxLength: 255 + minLength: 0 + example: '' + city: + type: string + maxLength: 128 + minLength: 0 + example: Gdansk + zip: + description: The ZIP/postal code, free text + type: string + maxLength: 64 + minLength: 0 + example: 80-387 + province: + type: string + maxLength: 255 + minLength: 0 + example: pomorskie + provinceCode: + description: The province code, free text + type: string + maxLength: 64 + minLength: 0 + example: '' + phone: + description: The phone number, free text + type: string + maxLength: 255 + minLength: 0 + example: '1122334455' + company: + description: The company name, free text + type: string + maxLength: 128 + minLength: 0 + example: GetResponse + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + NewAddress: + required: + - name + - countryCode + type: object + allOf: + - $ref: '#/components/schemas/Address' + UpdateAddress: + type: object + allOf: + - $ref: '#/components/schemas/Address' + Order: + properties: + orderId: + description: The order ID + type: string + readOnly: true + example: fOh + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/orders/fOh + contactId: + description: >- + Create a contact by using `POST /v3/contacts`. Or, if the contact + already exists, using `GET /v3/contacts` + type: string + example: k8u + orderUrl: + description: The external URL for an order + type: string + format: uri + maxLength: 2048 + example: https://somedomain.com/orders/order446 + externalId: + description: >- + The external ID is the identifying string or number of the order + given by another software + type: string + maxLength: 255 + example: DH71239 + totalPrice: + description: The total price of an order + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 716 + totalPriceTax: + description: The total price tax of an order + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 358.67 + currency: + description: The order currency code (ISO 4217) + type: string + example: PLN + status: + description: The status value + type: string + maxLength: 64 + example: NEW + cartId: + description: Create a cart by using `POST /v3/shops/{shopId}/carts` + type: string + example: QBNgBR + description: + description: The order description + type: string + example: More information about order. + shippingPrice: + description: The shipping price for an order + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 23 + shippingAddress: + description: The shipping address for an order + allOf: + - $ref: '#/components/schemas/NewAddress' + billingStatus: + description: The billing status of an order + type: string + example: PENDING + billingAddress: + description: The billing address for an order + allOf: + - $ref: '#/components/schemas/NewAddress' + processedAt: + description: The exact time an order was made + type: string + format: date-time + metaFields: + type: array + items: + $ref: '#/components/schemas/NewMetaField' + type: object + OrderResponse: + properties: + selectedVariants: + type: array + items: + $ref: '#/components/schemas/OrderSelectedProductVariant' + type: object + allOf: + - $ref: '#/components/schemas/Order' + NewOrder: + required: + - contactId + - totalPrice + - currency + - selectedVariants + properties: + selectedVariants: + type: array + items: + $ref: '#/components/schemas/NewSelectedProductVariant' + type: object + allOf: + - $ref: '#/components/schemas/Order' + UpdateOrder: + type: object + allOf: + - $ref: '#/components/schemas/Order' + NewSelectedProductVariant: + required: + - variantId + - price + - quantity + properties: + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/aS/products/Rf/variants/aBc + variantId: + description: >- + The ID of a selected variant. You must first create a variant + using: + + + `POST` [Create + product](https://apireference.getresponse.com/#operation/createProduct) + + + `POST` [Create product + variant](https://apireference.getresponse.com/#operation/createProductVariant) + + or get ID from variants created already: + + `GET` [Get a list of product variants](https://apireference.getresponse.com/#operation/getProductVariantList) + type: string + example: p + price: + description: The product variant price + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 840 + priceTax: + description: The product variant price tax + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 428 + quantity: + description: The product variant quantity + type: integer + format: int32 + minimum: 1 + example: '2' + taxes: + type: array + items: + $ref: '#/components/schemas/NewTax' + type: object + OrderSelectedProductVariant: + required: + - variantId + - price + - quantity + properties: + categories: + type: array + items: + $ref: '#/components/schemas/BaseCategory' + type: object + allOf: + - $ref: '#/components/schemas/NewSelectedProductVariant' + NewCartSelectedProductVariant: + required: + - variantId + - quantity + - price + - priceTax + properties: + variantId: + description: >- + The ID of a selected variant. You must first create a variant + using: + + + `POST` [Create + product](https://apireference.getresponse.com/#operation/createProduct) + + + `POST` [Create product + variant](https://apireference.getresponse.com/#operation/createProductVariant) + + or get ID from variants created already: + + `GET` [Get a list of product variants](https://apireference.getresponse.com/#operation/getProductVariantList) + type: string + example: VTB + quantity: + description: The quantity + type: integer + format: int64 + minimum: 1 + example: 3 + price: + description: The price, tax excluded + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 57 + priceTax: + description: The price, tax included + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 68 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/products/9I/variants/VTB + type: object + Cart: + properties: + cartId: + description: The contact ID + type: string + readOnly: true + example: V + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/carts/V + contactId: + description: >- + The ID of the contact that the cart belongs to. You must first + create the contact using POST /v3/contacts, or if it already exists, + using GET /v3/contacts + type: string + example: Vp + totalPrice: + description: The total cart price, tax excluded + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 1234.56 + totalTaxPrice: + description: The total cart price, tax included + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 1334.56 + currency: + description: The currency code (ISO 4217) + type: string + maxLength: 3 + minLength: 3 + example: USD + selectedVariants: + type: array + items: + $ref: '#/components/schemas/NewCartSelectedProductVariant' + externalId: + description: >- + The external ID is the identifying string or number of the cart, + given by another software + type: string + example: ext-1234 + cartUrl: + description: The external cart URL + type: string + format: url + example: http://example.com/cart/nQ + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + NewCart: + required: + - contactId + - totalPrice + - currency + - selectedVariants + type: object + allOf: + - $ref: '#/components/schemas/Cart' + UpdateCart: + type: object + allOf: + - $ref: '#/components/schemas/Cart' + Webinar: + properties: + webinarId: + type: string + readOnly: true + example: yK6d + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/webinars/yK6d + createdOn: + type: string + format: date-time + readOnly: true + startsOn: + type: string + format: date-time + webinarUrl: + description: The URL to the webinar room + type: string + format: uri + status: + type: string + enum: + - upcoming + - finished + - published + - unpublished + readOnly: true + type: + description: The webinar type + type: string + enum: + - all + - live + - on_demand + readOnly: true + campaigns: + type: array + items: + $ref: '#/components/schemas/CampaignReference' + newsletters: + description: The list of invitation messages + type: array + items: + $ref: '#/components/schemas/WebinarNewsletter' + statistics: + type: object + $ref: '#/components/schemas/WebinarStatistics' + type: object + WebinarStatistics: + required: + - registrants + - visitors + - attendees + properties: + registrants: + type: integer + format: int64 + example: 15 + visitors: + type: integer + format: int64 + example: 10 + attendees: + type: integer + format: int64 + example: 5 + type: object + WebinarNewsletter: + required: + - newsletterId + - href + properties: + newsletterId: + description: The ID of the webinar invitation message + type: string + example: NuE4 + href: + description: Direct hyperlink to a resource + type: string + example: https://api.getresponse.com/v3/newsletters/NuE4 + type: object + ContactCustomField: + properties: + customFieldId: + type: string + example: kL6Nh + values: + type: array + items: + type: string + example: 18-35 + type: object + ContactActivity: + properties: + activity: + description: The type of activity + type: string + enum: + - send + - open + - click + example: click + subject: + type: string + example: Shop offer update! + createdOn: + description: The activity date + type: string + format: date-time + previewUrl: + description: >- + This is only available for the `send` activity. It includes a link + to the message preview + type: string + format: uri + example: >- + https://www.grnewsletters.com/archive/campaign_name55f6b0ff01/Test-2135303.html + nullable: true + resource: + type: object + $ref: '#/components/schemas/ContactActivityResource' + clickTrack: + description: >- + This is only available for the `click` activity. It includes the + clicked link data + type: object + nullable: true + $ref: '#/components/schemas/ContactActivityClickTrack' + type: object + readOnly: true + ContactActivityClickTrack: + properties: + id: + description: The click tracking ID + type: string + example: 62WrE + name: + description: The name of the clicked link + type: string + example: Go to shop + url: + description: The URL of the clicked link + type: string + format: uri + example: https://my-shop.example.com/ + type: object + ContactActivityResource: + properties: + resourceId: + type: string + example: oY2n + nullable: true + resourceType: + type: string + enum: + - newsletters + - splittests + - autoresponders + - rss-newsletters + - sms + example: newsletters + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/newsletters/oY2n + type: object + ContactCustomFieldList: + type: array + items: + $ref: '#/components/schemas/ContactCustomField' + ContactListElement: + allOf: + - $ref: '#/components/schemas/Contact' + - properties: + note: + type: string + maxLength: 255 + minLength: 0 + nullable: true + ipAddress: + description: The contact's IP address. IPv4 and IPv6 formats are accepted. + example: 1.2.3.4 + oneOf: + - type: string + format: ipv4 + - type: string + format: ipv6 + type: object + ContactDetails: + type: object + allOf: + - $ref: '#/components/schemas/ContactListElement' + - properties: + geolocation: + type: object + readOnly: true + $ref: '#/components/schemas/ContactGeolocation' + tags: + description: The list of contact tags, limited to 500 tags. + type: array + items: + $ref: '#/components/schemas/ContactTag' + customFieldValues: + type: array + items: + $ref: '#/components/schemas/ContactCustomFieldValue' + type: object + ContactCustomFieldValue: + required: + - customFieldId + - name + - type + - value + - values + properties: + customFieldId: + description: Custom field ID + type: string + example: 4klkN + name: + type: string + example: age + value: + type: array + items: + type: string + example: 18-35 + values: + type: array + items: + type: string + example: 18-35 + type: + type: string + example: single_select + fieldType: + type: string + example: single_select + valueType: + type: string + example: string + type: object + ContactGeolocation: + properties: + latitude: + type: string + example: '54.35' + nullable: true + longitude: + type: string + example: '18.6667' + nullable: true + continentCode: + type: string + enum: + - OC + - AN + - SA + - NA + - AS + - EU + - AF + example: EU + nullable: true + countryCode: + description: The country code, compliant with ISO 3166-1 alpha-2 + type: string + example: PL + nullable: true + region: + type: string + example: '82' + nullable: true + postalCode: + type: string + example: 80-387 + nullable: true + dmaCode: + type: string + nullable: true + city: + type: string + example: Gdansk + nullable: true + type: object + BaseSearchContacts: + description: The short description of a saved search. + properties: + searchContactId: + description: The unique search-contact identifier + type: string + readOnly: true + example: pV3r + name: + description: The unique name of search-contact + type: string + example: custom test filter + createdOn: + description: The UTC date time format ISO 8601, e.g. 2018-04-10T10:02:57+0000 + type: string + format: date-time + readOnly: true + example: 2018-04-10T10:02:57+0000 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://app.getresponse.com/v3/search-contacts/pV3r + type: object + BaseSearchContactsDetails: + required: + - searchContactId + type: object + allOf: + - $ref: '#/components/schemas/BaseSearchContacts' + SearchContactsDetails: + description: Search contact details. + required: + - searchContactId + - name + - createdOn + - href + type: object + allOf: + - $ref: '#/components/schemas/SearchContactsConditionsDetails' + - $ref: '#/components/schemas/BaseSearchContacts' + SearchContactsConditionsDetails: + required: + - subscribersType + - sectionLogicOperator + - section + properties: + subscribersType: + description: Only one subscription status + type: array + items: + type: string + enum: + - subscribed + - undelivered + - removed + - unconfirmed + example: + - subscribed + sectionLogicOperator: + description: >- + Match 'any' (`or` value) or 'all' (`and` value) of the following + conditions + type: string + enum: + - or + - and + example: or + section: + type: array + items: + $ref: '#/components/schemas/SearchContactSection' + type: object + example: + subscribersType: + - subscribed + sectionLogicOperator: or + section: + - campaignIdsList: + - tamqY + logicOperator: or + subscriberCycle: + - receiving_autoresponder + - not_receiving_autoresponder + subscriptionDate: all_time + conditions: + - conditionType: crm + pipelineScope: PSVq + stageScope: all + NewSearchContacts: + description: New search contacts. + required: + - name + - subscribersType + - sectionLogicOperator + - section + type: object + allOf: + - $ref: '#/components/schemas/SearchContactsConditionsDetails' + - $ref: '#/components/schemas/BaseSearchContacts' + UpdateSearchContacts: + description: New search contacts. + required: + - name + - subscribersType + - sectionLogicOperator + - section + type: object + allOf: + - $ref: '#/components/schemas/SearchContactsConditionsDetails' + - $ref: '#/components/schemas/BaseSearchContacts' + SpecificDateEnum: + description: The specific date. + type: string + enum: + - today + - yesterday + - last_7_days + - last_30_days + - last_n_days + - this_week + - last_week + - this_month + - last_month + example: last_30_days + SpecificDateExtendedEnum: + description: The specific date. + type: string + example: last_30_days + oneOf: + - $ref: '#/components/schemas/SpecificDateEnum' + - description: The last 2 months specific date constant. + enum: + - last_2_months + RelationalNumericOperatorEnum: + description: The relational operators. + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_lt + MessageTypeOperator: + description: The type of message. + type: string + enum: + - autoresponder + - newsletter + - splittest + - automation + example: autoresponder + SearchedContactDetails: + properties: + contactId: + description: The contact identifier + type: string + example: jtLF5i + name: + description: The contact description + type: string + example: John Doe + nullable: true + email: + type: string + format: email + example: john.doe@example.com + origin: + type: string + enum: + - import + - email + - www + - panel + - leads + - sale + - api + - forward + - survey + - iphone + - copy + - landing_page + - webinar + example: landing_page + dayOfCycle: + type: string + format: integer + example: '153' + nullable: true + createdOn: + type: string + format: date-time + example: 2018-01-15T13:30:42+0000 + campaign: + type: object + example: + campaignId: tamqY + name: test_campaign + href: https://api.getresponse.com/v3/campaigns/tamqY + $ref: '#/components/schemas/CampaignReference' + score: + type: string + format: integer + example: '5' + nullable: true + reason: + type: string + enum: + - api + - automation + - blacklisted + - bounce + - cleaner + - complaint + - support + - unsubscribe + - user + example: support + nullable: true + deletedOn: + type: string + format: date-time + example: 2024-02-12T11:00:00+0000 + nullable: true + type: object + readOnly: true + SpecificDateType: + description: The date formatted as yyyy-mm-dd + type: string + format: date + example: '2018-04-01' + SpecificDateTimeType: + description: The date time string compliant with ISO 8601 + type: string + format: date + example: 2018-04-01T00:00:00+0000 + IntervalDateType: + description: >- + The date interval string compliant with ISO 8601, supported format: + / + type: string + example: 2018-04-01/2018-04-10 + ConditionStringOperator: + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - string_operator + example: string_operator + operator: + type: string + enum: + - is + - is_not + - contains + - not_contains + - starts + - ends + - not_starts + - not_ends + example: is_not + value: + type: string + example: new + type: object + example: + operatorType: string_operator + operator: starts + value: new + ConditionStringOperatorList: + description: Used with a custom field only. + required: + - operatorType + - operator + properties: + operatorType: + type: string + enum: + - string_operator_list + example: string_operator_list + operator: + type: string + enum: + - is + - is_not + - contains + - not_contains + - starts + - ends + - not_starts + - not_ends + - assigned + - not_assigned + example: is + value: + description: The value of the search + type: string + example: 18-29 + type: object + example: + operatorType: string_operator_list + operator: is + value: 18-29 + ConditionMessageOperator: + description: The operator allows searching by message type. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - message_operator + example: message_operator + operator: + $ref: '#/components/schemas/MessageTypeOperator' + value: + description: >- + The identifier of a selected resource: autoresponder, newsletter, + split test or automation message + type: string + example: SGNLr + type: object + example: + operatorType: message_operator + operator: autoresponder + value: SGNLr + CustomDateRange: + required: + - from + - to + properties: + from: + description: The UTC date format + type: string + format: date + example: '2018-04-01' + to: + description: The UTC date format + type: string + format: date + example: '2018-04-10' + type: object + SectionAllTimeSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionTodaySubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionYesterdaySubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionLast7DaysSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionLast30DaysSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionThisWeekSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionLastWeekSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionThisMonthSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionLastMonthSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionLast2MonthsSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionCustomSubscriptionDate: + required: + - customDate + properties: + customDate: + type: object + $ref: '#/components/schemas/CustomDateRange' + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SearchContactSection: + required: + - campaignIdsList + - logicOperator + - subscriberCycle + - subscriptionDate + properties: + campaignIdsList: + description: An array of campaign identifiers + type: array + items: + type: string + example: tamqY + example: + - tamqY + - tuKd3 + logicOperator: + type: string + enum: + - and + - or + subscriberCycle: + description: Defining whether or not a subscriber is in an autoresponder cycle + type: array + items: + type: string + enum: + - receiving_autoresponder + - not_receiving_autoresponder + example: + - receiving_autoresponder + - not_receiving_autoresponder + conditions: + description: One of the search contact conditions + type: array + items: + $ref: '#/components/schemas/ConditionType' + subscriptionDate: + description: Matches the matching period + type: string + enum: + - all_time + - today + - yesterday + - last_7_days + - last_30_days + - this_week + - last_week + - this_month + - last_month + - last_2_months + - custom + type: object + discriminator: + propertyName: subscriptionDate + mapping: + all_time: '#/components/schemas/SectionAllTimeSubscriptionDate' + today: '#/components/schemas/SectionTodaySubscriptionDate' + yesterday: '#/components/schemas/SectionYesterdaySubscriptionDate' + last_7_days: '#/components/schemas/SectionLast7DaysSubscriptionDate' + last_30_days: '#/components/schemas/SectionLast30DaysSubscriptionDate' + this_week: '#/components/schemas/SectionThisWeekSubscriptionDate' + last_week: '#/components/schemas/SectionLastWeekSubscriptionDate' + this_month: '#/components/schemas/SectionThisMonthSubscriptionDate' + last_month: '#/components/schemas/SectionLastMonthSubscriptionDate' + last_2_months: '#/components/schemas/SectionLast2MonthsSubscriptionDate' + custom: '#/components/schemas/SectionCustomSubscriptionDate' + ConditionType: + required: + - conditionType + properties: + conditionType: + type: string + enum: + - name + - email + - custom + - subscription_date + - subscription_method + - opened + - not_opened + - phase + - last_send_date + - last_click_date + - last_open_date + - webinar + - clicked + - not_clicked + - sent + - not_sent + - geo + - scoring + - engagement_score + - tag + - goal + - crm + - ecommerce_number_of_purchases + - ecommerce_total_spent + - ecommerce_product_purchased + - ecommerce_brand_purchased + - ecommerce_abandoned_cart + - sms_sent + - sms_delivered + - sms_link_clicked + - sms_link_not_clicked + - custom_event + type: object + discriminator: + propertyName: conditionType + mapping: + name: '#/components/schemas/NameCondition' + email: '#/components/schemas/EmailCondition' + custom: '#/components/schemas/CustomFieldCondition' + subscription_date: '#/components/schemas/SubscriptionDateCondition' + subscription_method: '#/components/schemas/SubscriptionMethodCondition' + opened: '#/components/schemas/OpenedCondition' + not_opened: '#/components/schemas/NotOpenedCondition' + phase: '#/components/schemas/AutoresponderDayCondition' + last_send_date: '#/components/schemas/LastSendDateCondition' + last_click_date: '#/components/schemas/LastClickDateCondition' + last_open_date: '#/components/schemas/LastOpenDateCondition' + webinar: '#/components/schemas/WebinarCondition' + clicked: '#/components/schemas/LinkClickedCondition' + not_clicked: '#/components/schemas/LinkNotClickedCondition' + sent: '#/components/schemas/MessageSentCondition' + not_sent: '#/components/schemas/MessageNotSentCondition' + geo: '#/components/schemas/GeolocationCondition' + scoring: '#/components/schemas/ScoringCondition' + engagement_score: '#/components/schemas/EngagementScoreCondition' + tag: '#/components/schemas/TagCondition' + goal: '#/components/schemas/GoalCondition' + crm: '#/components/schemas/CrmCondition' + ecommerce_number_of_purchases: '#/components/schemas/ECommerceNumberOfPurchasesCondition' + ecommerce_total_spent: '#/components/schemas/ECommerceTotalSpentCondition' + ecommerce_product_purchased: '#/components/schemas/ECommerceProductPurchasedCondition' + ecommerce_brand_purchased: '#/components/schemas/ECommerceBrandPurchasedCondition' + sms_sent: '#/components/schemas/SmsSentCondition' + sms_delivered: '#/components/schemas/SmsDeliveredCondition' + sms_link_clicked: '#/components/schemas/SmsLinkClickedCondition' + sms_link_not_clicked: '#/components/schemas/SmsLinkNotClickedCondition' + ecommerce_abandoned_cart: '#/components/schemas/ECommerceAbandonedCartCondition' + custom_event: '#/components/schemas/CustomEventCondition' + NameCondition: + type: object + example: + conditionType: name + operatorType: string_operator + operator: contains + value: John + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionStringOperator' + EmailCondition: + type: object + example: + conditionType: email + operatorType: string_operator + operator: contains + value: john + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionStringOperator' + CustomFieldCondition: + description: Search a contact by custom fields. + required: + - operator + - scope + - operatorType + properties: + operatorType: + description: >- + Depends on the type of custom field, read more in [custom field + condition documentation in segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual#get-by-custom-fields-search-contacts) + type: string + enum: + - string_operator_list + - string_operator + - numeric_operator + - date_operator + example: string_operator_list + operator: + description: >- + Depends on selected `"operatorType"`, read more in [custom field + condition documentation in segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual#get-by-custom-fields-search-contacts) + type: string + example: is + oneOf: + - $ref: '#/components/schemas/CustomFieldStringOperatorEnum' + - $ref: '#/components/schemas/CustomFieldNumericOperatorEnum' + - $ref: '#/components/schemas/CustomFieldDateOperatorEnum' + value: + description: >- + Depends on selected `"operator"` and `"operatorType"`, read more in + [custom field condition documentation in segments (search contacts) + reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual#get-by-custom-fields-search-contacts) + type: string + example: new + oneOf: + - $ref: '#/components/schemas/CustomFieldValueForStringOperatorTypes' + - $ref: '#/components/schemas/CustomFieldValueForNumericOperatorType' + - $ref: >- + #/components/schemas/CustomFieldValueForOperatorTypeDateAndOperatorSpecificDate + - $ref: >- + #/components/schemas/CustomFieldValueDateForOperatorTypeDateAndOperatorDateToOrDateFrom + - $ref: >- + #/components/schemas/CustomFieldValueDateTimeForOperatorTypeDateAndOperatorDateToOrDateFrom + - $ref: >- + #/components/schemas/CustomFieldValueForOperatorTypeDateAndOperatorCustom + scope: + description: >- + The identifier of the custom field, read more in [custom field + condition documentation in segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual#get-by-custom-fields-search-contacts) + type: string + numberOfDays: + description: >- + Required only when `"value":"last_n_days"`, read more in [custom + field condition documentation in segments (search contacts) + reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual#get-by-custom-fields-search-contacts) + type: integer + example: 20 + includeCurrentPeriod: + description: >- + Flag determines if current day will be included into chosen range. + This flag can be used with `last_n_days`. + type: boolean + example: true + type: object + example: + conditionType: custom + scope: pa3N6 + operatorType: string_operator_list + operator: is + value: Female + allOf: + - $ref: '#/components/schemas/ConditionType' + CustomFieldStringOperatorEnum: + description: >- + Allowed operators for `"operatorType":"string_operator"` and + `"operatorType":"string_operator_list"` + type: string + enum: + - is + - is_not + - contains + - not_contains + - starts + - ends + - not_starts + - not_ends + - assigned + - not_assigned + example: is + CustomFieldNumericOperatorEnum: + description: Allowed operators for `"operatorType":"numeric_operator"` + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + - assigned' + - not_assigned + example: numeric_lt + CustomFieldDateOperatorEnum: + description: Allowed operators for `"operatorType":"date_operator"` + type: string + enum: + - date_to + - date_from + - custom + - specific_date + - assigned + - not_assigned + example: date_to + CustomFieldValueForStringOperatorTypes: + description: >- + Any string, allowed only for `"operatorType":"string_operator"` and + `"operatorType":"string_operator_list"` + type: string + example: Canada + CustomFieldValueForNumericOperatorType: + description: Any number, allowed only for `"operatorType":"numeric_operator"` + type: string + example: '1' + CustomFieldValueForOperatorTypeDateAndOperatorSpecificDate: + description: >- + Allowed values for `"operatorType":"date_operator"` with + `"operator":"specific_date"` + type: string + enum: + - today + - yesterday + - last_7_days + - last_30_days + - last_n_days + - this_week + - last_week + - this_month + - last_month + - last_2_months + example: today + CustomFieldValueDateForOperatorTypeDateAndOperatorDateToOrDateFrom: + description: >- + Date string formatted as yyyy-mm-dd, allowed only for + `"operatorType":"date_operator"` with `"operator":"date_to"` or + `"operator":"date_from"` + allOf: + - $ref: '#/components/schemas/SpecificDateType' + CustomFieldValueDateTimeForOperatorTypeDateAndOperatorDateToOrDateFrom: + description: >- + Date time string compliant with ISO 8601, allowed only for + `"operatorType":"date_operator"` with `"operator":"date_to"` or + `"operator":"date_from"` + allOf: + - $ref: '#/components/schemas/SpecificDateTimeType' + CustomFieldValueForOperatorTypeDateAndOperatorCustom: + description: >- + Date interval string compliant with ISO 8601, supported format: + /, allowed only for + `"operatorType":"date_operator"` with `"operator":"custom"` + allOf: + - $ref: '#/components/schemas/IntervalDateType' + SubscriptionDateCondition: + description: Use this to find a contact by subscription date, use. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - date_operator + example: date_operator + operator: + type: string + enum: + - date_to + - date_from + - specific_date + - custom + value: + type: string + example: 2018-04-01/2018-04-30 + oneOf: + - allOf: + - $ref: '#/components/schemas/SpecificDateType' + - allOf: + - $ref: '#/components/schemas/SpecificDateTimeType' + - allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + - allOf: + - $ref: '#/components/schemas/IntervalDateType' + type: object + example: + conditionType: subscription_date + operatorType: date_operator + operator: custom + value: 2018-04-01/2018-04-30 + allOf: + - $ref: '#/components/schemas/ConditionType' + SubscriptionMethodCondition: + description: The subscription method. + required: + - method + properties: + method: + type: string + enum: + - webform + - import + - landing_page + - api + - email + - panel + - mobile + - forward + - survey + - sales + - copy + - leads + - webinar + webformType: + description: >- + The property required for the webform subscription method. If it + equals webforms, webformsv2 or popups, additonal property value is + needed. + type: string + enum: + - all + - webforms + - webformsv2 + - popups + value: + description: >- + The field required for `import`, `landing_page` and `webinar`, + optional for the `webform` method + type: string + oneOf: + - description: >- + If the method value equals `webform`, then the value is equal to + the webform, webformv2 or popup identifiers. The field is + required for the webformType={webforms, webformsv2, popups}. + example: PSO39 + - description: >- + If the method value equals `import`, then the value is equal to + the import identifier, or all for ‘all’ imports. + example: all + - description: >- + If the method value equals `landing_page`, then the value is + equal to the landing page identifier, or ‘all’ for all landing + pages + example: all + - description: >- + If the method value equals `webinar`, then the value is equal to + the webinar identifier, or ‘all’ for all webinars + example: all + type: object + allOf: + - $ref: '#/components/schemas/ConditionType' + OpenedCondition: + description: Search contacts who did open a message. + type: object + example: + conditionType: opened + operatorType: message_operator + operator: autoresponder + value: 'SGNLr:' + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionMessageOperator' + NotOpenedCondition: + description: Search contacts who didn't open a message. + required: + - operatorType + - operator + - dateOperator + properties: + operatorType: + type: string + enum: + - complex_message_operator + example: complex_message_operator + operator: + description: Specifies the type of message to search for + example: newsletter + oneOf: + - description: For all available message types + type: string + enum: + - all + example: all + - $ref: '#/components/schemas/MessageTypeOperator' + scope: + description: >- + The message identifier. Required only for the operator different + from 'all'. + type: string + example: z4Zje + dateOperator: + description: >- + It allows you to set a date range. For some of them `value` will be + required. Examples can be found here: [API + Docs](https://apidocs.getresponse.com/v3/case-study/segments-manual#not-opened-action). + type: string + enum: + - date_from + - never + - today + - yesterday + - last_7_days + - last_30_days + - last_n_days + - this_week + - this_month + value: + description: >- + This field is required only for `date_from` and `last_n_days` date + operators. + oneOf: + - description: >- + The date string compliant with ISO 8601. The value field is + required for the dateOperator equal to `date_from`. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: Number of days. Required for `last_n_days` date operator. + type: integer + example: 10 + includeCurrentPeriod: + description: >- + Flag determines if current day will be included into chosen range. + This flag can be used with `last_7_days`, `last_30_days`, + `last_n_days`. + type: boolean + example: true + type: object + example: + conditionType: not_opened + operatorType: complex_message_operator + scope: z4Zje + operator: autoresponder + dateOperator: never + allOf: + - $ref: '#/components/schemas/ConditionType' + AutoresponderDayCondition: + description: To find the autoresponder cycle day of a contact. + required: + - operatorType + - operator + properties: + operatorType: + type: string + enum: + - numeric_operator + operator: + type: string + oneOf: + - $ref: '#/components/schemas/RelationalNumericOperatorEnum' + - enum: + - assigned + - not_assigned + example: assigned + value: + description: >- + The autoresponder cycle day value. The field is prohibited for the + operators assigned and not_assigned. + type: integer + format: int32 + example: 6 + type: object + example: + conditionType: phase + operatorType: numeric_operator + operator: numeric_eq + value: 6 + allOf: + - $ref: '#/components/schemas/ConditionType' + LastSendDateCondition: + description: Search the last time when an email message was sent to a contact. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - date_operator + operator: + type: string + enum: + - date_to + - date_from + - specific_date + - custom + value: + type: string + example: last_7_days + oneOf: + - description: >- + For `date_to` or `date_from` operators. Date string is compliant + with ISO 8601. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: >- + For the operator=custom, it's the time interval compliant with + ISO 8601 + allOf: + - $ref: '#/components/schemas/IntervalDateType' + - description: For a specific_date operator + allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + type: object + example: + conditionType: last_send_date + operatorType: date_operator + operator: specific_date + value: last_7_days + allOf: + - $ref: '#/components/schemas/ConditionType' + LastClickDateCondition: + description: This is used to find the last time when a contact clicked a message. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - date_operator + example: date_operator + operator: + type: string + enum: + - date_to + - date_from + - specific_date + - custom + example: specific_date + value: + type: string + example: last_7_days + oneOf: + - description: >- + For `date_to` or `date_from` operators. Date string is compliant + with ISO 8601. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: >- + For the operator=custom, it's the time interval compliant with + ISO 8601 + allOf: + - $ref: '#/components/schemas/IntervalDateType' + - description: For the specific_date operator + allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + type: object + example: + conditionType: last_click_date + operatorType: date_operator + operator: specific_date + value: last_7_days + allOf: + - $ref: '#/components/schemas/ConditionType' + LastOpenDateCondition: + description: Search the last time when a contact opened a message. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - date_operator + example: date_operator + operator: + type: string + enum: + - date_to + - date_from + - specific_date + - custom + example: specific_date + value: + type: string + example: last_7_days + oneOf: + - description: >- + For `date_to` or `date_from` operators. Date string is compliant + with ISO 8601. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: >- + For the operator=custom, it's the time interval compliant with + ISO 8601 + allOf: + - $ref: '#/components/schemas/IntervalDateType' + - description: For the specific_date operator + allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + type: object + example: + conditionType: last_open_date + operatorType: date_operator + operator: specific_date + value: last_7_days + allOf: + - $ref: '#/components/schemas/ConditionType' + WebinarCondition: + description: >- + Search contacts that have participated/not participated in a specific + webinar as a host/listener/presenter/registrant/any user. + required: + - scope + - webinarCondition + - contactType + properties: + scope: + description: The identifier of a webinar + type: string + example: MNAR + webinarCondition: + type: string + enum: + - participated + - not_participated + example: participated + contactType: + type: string + enum: + - host + - listener + - presenter + - registrant + - all + example: presenter + type: object + example: + conditionType: webinar + scope: MNAR + webinarCondition: participated + contactType: presenter + allOf: + - $ref: '#/components/schemas/ConditionType' + LinkClickedCondition: + description: Search contacts that clicked on a link. + required: + - operatorType + - operator + - scope + - clickTrackId + properties: + operatorType: + type: string + enum: + - message_operator + example: message_operator + operator: + $ref: '#/components/schemas/MessageTypeOperator' + scope: + description: The message identifier + type: string + example: SGNLr + clickTrackId: + oneOf: + - type: string + enum: + - all + example: all + - description: The identifier of the clickTrackId + type: string + example: SGNLr + type: object + example: + conditionType: clicked + operatorType: message_operator + operator: autoresponder + scope: SGNLr + clickTrackId: all + allOf: + - $ref: '#/components/schemas/ConditionType' + LinkNotClickedCondition: + description: Search contacts that didn't click a link. + required: + - operatorType + - operator + - dateOperator + properties: + operatorType: + type: string + enum: + - complex_message_operator + example: complex_message_operator + operator: + example: newsletter + oneOf: + - description: For all available message types + type: string + enum: + - all + example: all + - $ref: '#/components/schemas/MessageTypeOperator' + dateOperator: + description: >- + It allows you to set a date range. For some of them `value` will be + required. Examples can be found here: [API + Docs](https://apidocs.getresponse.com/v3/case-study/segments-manual#not-opened-action). + enum: + - date_from + - never + - today + - yesterday + - last_7_days + - last_30_days + - last_n_days + - this_week + - this_month + example: today + value: + description: >- + This field is required only for `date_from` and `last_n_days` date + operators. + oneOf: + - description: >- + The date string compliant with ISO 8601. The value field is + required for the dateOperator equal to `date_from`. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: Number of days. Required for `last_n_days` date operator. + type: integer + example: 10 + includeCurrentPeriod: + description: >- + Flag determines if current day will be included into chosen range. + This flag can be used with `last_7_days`, `last_30_days`, + `last_n_days`. + type: boolean + example: true + scope: + description: >- + The message identifier. This field is prohibited for the 'all' + operator. + type: string + example: zhgnQ + clickTrackId: + description: The click track identifier + type: string + example: PPxiOW + oneOf: + - description: For all possible links in a message + enum: + - all + example: all + - description: For a specified click track ID + example: PPxiOW + type: object + example: + conditionType: not_clicked + operatorType: complex_message_operator + operator: newsletter + dateOperator: today + scope: zhgnQ + clickTrackId: all + allOf: + - $ref: '#/components/schemas/ConditionType' + MessageSentCondition: + description: Search contacts who received a certain message. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - message_operator + example: message_operator + operator: + $ref: '#/components/schemas/MessageTypeOperator' + value: + description: The message identifier + type: string + example: zSFIB + type: object + example: + conditionType: sent + operatorType: message_operator + operator: autoresponder + value: zSFIB + allOf: + - $ref: '#/components/schemas/ConditionType' + MessageNotSentCondition: + description: Search contacts who didn't receive a certain message. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - message_operator + example: message_operator + operator: + $ref: '#/components/schemas/MessageTypeOperator' + value: + description: The message identifier + type: string + example: z4Zje + type: object + example: + conditionType: not_sent + operatorType: message_operator + operator: autoresponder + value: z4Zje + allOf: + - $ref: '#/components/schemas/ConditionType' + ECommerceBrandPurchasedCondition: + description: Search contacts by brand purchased. + required: + - scope + - operatorType + - operator + - value + properties: + scope: + description: The shop identifier + type: string + example: ZTo + operatorType: + type: string + enum: + - equal_operator + example: equal_operator + operator: + type: string + enum: + - is + - not_is + example: is + value: + type: string + example: GetResponse + type: object + example: + conditionType: ecommerce_brand_purchased + scope: ZTo + operatorType: equal_operator + operator: is + value: GetResponse + allOf: + - $ref: '#/components/schemas/ConditionType' + ECommerceProductPurchasedCondition: + description: Search the product purchased. + required: + - shopScope + - categoryScope + - operatorType + - operator + - productScope + - dateOperator + properties: + shopScope: + description: Limit the searched shops + type: string + oneOf: + - description: For all available shops + enum: + - all + example: all + - description: The shop identifier + example: ZTo + categoryScope: + description: The product category + type: string + oneOf: + - description: For all available categories + enum: + - all + example: all + - description: The category identifier + example: PZ3 + operatorType: + type: string + enum: + - equal_operator + example: equal_operator + operator: + type: string + enum: + - is + - is_not + example: is + productScope: + type: string + oneOf: + - description: For all available products + enum: + - all + example: all + - description: For a specified product + example: oZt + dateOperator: + description: >- + Set a date range. For the date_from and date_to, custom field value + is required. + type: string + oneOf: + - description: >- + The field value is prohibited. The date string is compliant with + ISO 8601. + allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + - description: The field value is prohibited + enum: + - all_time + example: all_time + - description: The field value is required + enum: + - date_to + - date_from + - custom + value: + description: >- + This field stores the date or time interval for the date operators + date_to, date_from, or custom + type: string + example: '2018-04-01' + oneOf: + - description: >- + For the dateOperator date_to and date_from, it's the time + compliant with ISO 8601 + $ref: '#/components/schemas/SpecificDateType' + - description: >- + For the dateOperator=custom, it's the time interval compliant + with ISO 8601 + $ref: '#/components/schemas/IntervalDateType' + type: object + example: + conditionType: ecommerce_product_purchased + shopScope: all + categoryScope: all + operatorType: equal_operator + operator: is + productScope: all + dateOperator: date_from + value: '2018-04-01' + allOf: + - $ref: '#/components/schemas/ConditionType' + ECommerceTotalSpentCondition: + description: Search contacts by total spent. + required: + - operatorType + - operator + - scope + - value + - currency + properties: + operatorType: + type: string + enum: + - numeric_operator + example: numeric_operator + operator: + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_eq + scope: + description: The condition limiting the searched shop + type: string + example: Zto + oneOf: + - description: For all available shops + enum: + - all + example: all + - description: The shop identifier + example: ZTo + value: + type: number + format: double + example: '7.00' + currency: + description: The currency code according to ISO 4217, i.e. USD, GBP, PLN + type: string + example: USD + type: object + example: + conditionType: ecommerce_total_spent + scope: all + operatorType: numeric_operator + operator: numeric_eq + value: 7 + currency: USD + allOf: + - $ref: '#/components/schemas/ConditionType' + ECommerceNumberOfPurchasesCondition: + description: Search contacts by the number of purchases. + required: + - operatorType + - operator + - scope + - value + properties: + operatorType: + type: string + enum: + - numeric_operator + example: numeric_operator + operator: + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_eq + scope: + description: The condition limiting the searched shop + type: string + example: Zto + oneOf: + - description: For all available shops + enum: + - all + example: all + - description: The shop identifier + example: ZTo + value: + type: integer + format: int32 + example: 7 + type: object + example: + conditionType: ecommerce_number_of_purchases + scope: all + operatorType: numeric_operator + operator: numeric_eq + value: 7 + allOf: + - $ref: '#/components/schemas/ConditionType' + TagCondition: + description: Search contacts by tag. + required: + - operatorType + - operator + - value + properties: + operatorType: + description: The operator for the existence of a property + type: string + enum: + - exists + example: exists + operator: + description: >- + This operator verifies whether the property you are looking for + exists or not + type: string + enum: + - exists + - not_exists + example: exists + value: + description: The tag identifier + type: string + example: BB + type: object + example: + conditionType: tag + value: BB + operatorType: exists + operator: exists + allOf: + - $ref: '#/components/schemas/ConditionType' + ECommerceAbandonedCartCondition: + description: Search contacts by abandoned cart. + required: + - shopScope + - dateOperator + properties: + shopScope: + description: Limit the searched shops + type: string + oneOf: + - description: For all available shops + enum: + - all + example: all + - description: The shop identifier + example: ZTo + dateOperator: + description: >- + Set a date range. For the date_from and last_n_days, custom field + value is required. Examples can be found here: [API + Docs](https://apidocs.getresponse.com/v3/case-study/segments-manual/#ecommerce-abandoned-cart-condition-type). + type: string + enum: + - date_from + - anytime + - never + - today + - yesterday + - last_n_days + - this_week + - this_month + value: + description: >- + This field is required only for `date_from` and `last_n_days` date + operators. + oneOf: + - description: >- + The date string compliant with ISO 8601. The value field is + required for the dateOperator equal to `date_from`. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: Number of days. Required for `last_n_days` date operator. + type: integer + example: 10 + includeCurrentPeriod: + description: >- + Flag determines if current day will be included into chosen range. + This flag can be used with `last_n_days`. + type: boolean + example: true + type: object + example: + conditionType: ecommerce_abandoned_cart + shopScope: ZTo + dateOperator: date_from + value: '2018-04-01' + allOf: + - $ref: '#/components/schemas/ConditionType' + SmsSentCondition: + description: Find contacts who were sent an SMS + required: + - smsId + properties: + smsId: + description: The SMS message ID + type: string + example: ZTo + type: object + example: + conditionType: sms_sent + smsId: ZTo + allOf: + - $ref: '#/components/schemas/ConditionType' + SmsDeliveredCondition: + description: Find contacts who received an SMS + required: + - smsId + properties: + smsId: + description: The SMS message ID + type: string + example: ZTo + type: object + example: + conditionType: sms_delivered + smsId: ZTo + allOf: + - $ref: '#/components/schemas/ConditionType' + SmsLinkClickedCondition: + description: Find contacts who clicked a link from an SMS + required: + - smsId + - clickTrackId + properties: + smsId: + description: The SMS message ID + type: string + example: ZTo + clickTrackId: + description: The click track ID + type: string + example: ABc + type: object + example: + conditionType: sms_link_clicked + smsId: ZTo + clickTrackId: ABc + allOf: + - $ref: '#/components/schemas/ConditionType' + SmsLinkNotClickedCondition: + description: Find contacts who didn't click a link from an SMS + required: + - smsId + - clickTrackId + properties: + smsId: + description: The SMS message ID + type: string + example: ZTo + clickTrackId: + description: The click track ID + type: string + example: ABc + type: object + example: + conditionType: sms_link_not_clicked + smsId: ZTo + clickTrackId: ABc + allOf: + - $ref: '#/components/schemas/ConditionType' + ScoringCondition: + description: Search contacts by scoring. + required: + - operatorType + properties: + operatorType: + type: string + enum: + - numeric_operator + - not_exists + example: numeric_operator + operator: + description: >- + The relational operator. Required for the + operatorType=numeric_operator. + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_lt + value: + description: >- + This field is required for the relational operator, and prohibited + for the not_exists operator type + type: integer + format: int32 + example: 5 + type: object + example: + conditionType: score + operatorType: numeric_operator + operator: numeric_lt + value: 5 + allOf: + - $ref: '#/components/schemas/ConditionType' + EngagementScoreCondition: + description: Search contacts by their engagement score + required: + - operator + - value + properties: + operatorType: + type: string + enum: + - numeric_operator + example: numeric_operator + operator: + description: The operator used in engagement score comparison + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_lt + value: + description: The condition value + type: integer + format: int32 + example: 5 + type: object + example: + conditionType: engagement_score + operatorType: numeric_operator + operator: numeric_lt + value: 5 + allOf: + - $ref: '#/components/schemas/ConditionType' + GeolocationCondition: + description: Search contacts by geolocation. + required: + - operatorType + - operator + - value + - scope + properties: + scope: + description: Specify the search parameters + type: string + enum: + - country + - country_code + - region + - city + - longitude + - latitude + - postal_code + - dma_code + example: city + type: object + example: + conditionType: geo + operatorType: string_operator + operator: starts + value: New + scope: city + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionStringOperator' + CrmCondition: + description: This makes it possible to search contacts by CRM conditions. + required: + - pipelineScope + - stageScope + properties: + pipelineScope: + description: The pipeline identifier + type: string + example: PSVq + stageScope: + description: '' + type: string + example: ZAHB + oneOf: + - description: For all available stages + enum: + - all + example: all + - description: The stage identifier + example: ZAHB + type: object + example: + conditionType: crm + pipelineScope: PSVq + stageScope: ZAHB + allOf: + - $ref: '#/components/schemas/ConditionType' + GoalCondition: + description: Search contacts by a defined goal. + required: + - operatorType + - operator + - scope + properties: + operatorType: + type: string + enum: + - numeric_operator + example: numeric_operator + operator: + description: >- + The relational and existence operator. For the relational operator, + the value field is required. + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + - assigned + - not_assigned + example: numeric_lt + value: + description: >- + The value to be compared for the relational operator. For the + assigned, the not_assigned operator field is prohibited. + type: integer + format: int32 + example: 5 + scope: + description: The goal identifier + type: string + example: p22 + type: object + example: + conditionType: goal + operatorType: numeric_operator + operator: numeric_lt + value: '5' + scope: p22 + allOf: + - $ref: '#/components/schemas/ConditionType' + CustomEventCondition: + description: Search contacts for which an custom event occurred / not occurred + required: + - customEventId + - occurrence + - dateOperator + properties: + customEventId: + description: The custom event identifier + type: string + example: PNM + occurrence: + description: Whether the custom event occurred or not + type: string + enum: + - occurred + - not_occurred + example: occurred + dateOperator: + description: >- + Show contacts for which a custom event occurred / not occurred in + certain date range + type: string + oneOf: + - allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + - description: Anytime + enum: + - anytime + example: anytime + - description: >- + Allows you to choose a custom date range. The `date` field must + be set to use this operator. + enum: + - date_to + - date_from + - custom + date: + description: >- + The operators `date_to`, `date_from`, and `customDate` require you + to provide, respectively, a date, datetime, or a time interval. + type: string + example: '2018-04-01' + oneOf: + - $ref: '#/components/schemas/SpecificDateType' + - $ref: '#/components/schemas/SpecificDateTimeType' + - $ref: '#/components/schemas/IntervalDateType' + type: object + example: + conditionType: custom_event + customEventId: PNM + occurrence: occurred + dateOperator: date_from + value: '2018-04-01' + allOf: + - $ref: '#/components/schemas/ConditionType' + CreateTransactionalEmail: + required: + - fromField + - subject + - recipients + - contentType + properties: + fromField: + description: The 'From' address ID to be used as the message sender + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The 'From' address ID to be used as the Reply-to + allOf: + - $ref: '#/components/schemas/FromFieldReference' + tag: + description: The tag ID used for statistical data collection + allOf: + - $ref: '#/components/schemas/NewTransactionalEmailTag' + recipients: + $ref: '#/components/schemas/TransactionalEmailRecipients' + contentType: + description: The message content type + type: string + default: direct + enum: + - direct + - template + type: object + discriminator: + propertyName: contentType + mapping: + direct: '#/components/schemas/DirectContent' + template: '#/components/schemas/TemplateContent' + DirectContent: + type: object + allOf: + - $ref: '#/components/schemas/CreateTransactionalEmail' + - $ref: '#/components/schemas/TransactionalEmailContent' + TemplateContent: + type: object + allOf: + - $ref: '#/components/schemas/CreateTransactionalEmail' + - $ref: '#/components/schemas/TransactionalEmailTemplate' + NewTransactionalEmailTag: + required: + - tagId + properties: + tagId: + type: string + example: vBd5 + type: object + TransactionalEmailContent: + required: + - content + properties: + subject: + type: string + maxLength: 512 + minLength: 1 + example: Order Confirmation - Example Shop + attachments: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailAttachment' + content: + description: >- + The message content. At least one field is required. The maximum + combined size of plain text and HTML is 16MB + properties: + plain: + type: string + example: Your order has been confirmed. Thank you for shopping with us! + html: + type: string + example: >- +

Your order has been confirmed

Thank you for + shopping with us! + type: object + type: object + TransactionalEmailTemplate: + description: The template content + required: + - template + properties: + template: + description: The message template. At least templateId is required + required: + - templateId + properties: + templateId: + description: Transactional emails template identifier + type: string + example: Ykz + lexpad: + description: Transactional email lexpad + type: object + example: + some-key: some-value + type: object + type: object + TransactionalEmailRecipients: + required: + - to + properties: + to: + $ref: '#/components/schemas/TransactionalEmailRecipientTo' + cc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipient' + bcc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipient' + type: object + TransactionalEmailRecipientTo: + required: + - email + properties: + validSince: + description: The first time this address appeared in your system + type: string + format: date-time + example: 2018-05-02T09:30:43+0200 + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipient' + TransactionalEmailRecipient: + required: + - email + properties: + email: + type: string + format: email + example: john.doe@example.com + name: + type: string + maxLength: 128 + minLength: 1 + example: John Doe + status: + type: string + enum: + - unknown + - sent + - rejected + - opened + - bounced + - reported_spam + readOnly: true + type: object + TransactionalEmailAttachment: + required: + - fileName + - content + - mimeType + properties: + fileName: + type: string + maxLength: 128 + minLength: 3 + example: pixel.png + mimeType: + description: The MIME attachment type + type: string + maxLength: 128 + minLength: 3 + example: image/png + content: + description: The base64-encoded attachment + type: string + format: base64 + example: >- + iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mOUua1dDwAD4AGjnrXmUAAAAABJRU5ErkJggg== + type: object + TransactionalEmailsTemplateDetails: + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmailsTemplateListElement' + - properties: + content: + $ref: '#/components/schemas/TransactionalEmailTemplateContent' + type: object + TransactionalEmailsTemplateListElement: + properties: + templateId: + description: Transactional email template ID + type: string + readOnly: true + example: p + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api3.getresponse360.com/v3/transactional-emails/templates/tRe4i + subject: + description: The template subject + type: string + example: Order Confirmation Template + createdOn: + description: The creation date + type: string + format: date-time + updatedOn: + description: The date of the last template update + type: string + format: date-time + editor: + description: The Editor type + allOf: + - type: string + enum: + - html + - wysiwyg + type: object + CreateTransactionalEmailTemplate: + required: + - subject + properties: + subject: + description: The template subject + type: string + example: Order Confirmation - Example Shop + content: + $ref: '#/components/schemas/TransactionalEmailTemplateContent' + type: object + TransactionalEmailTemplateContent: + description: The template content. At least one field is required + properties: + plain: + description: The plain text equivalent of template content + type: string + example: Your order has been confirmed. Thank you for shopping with us! + html: + description: The template content in HTML + type: string + example: >- +

Your order has been confirmed

Thank you for shopping + with us! + type: object + TransactionalEmailRecipientStatuses: + properties: + rejectedOn: + type: string + format: date-time + readOnly: true + example: null + nullable: true + openedOn: + type: string + format: date-time + readOnly: true + example: 2019-06-02T09:30:43+0200 + nullable: true + bouncedOn: + type: string + format: date-time + readOnly: true + example: null + nullable: true + complainedOn: + type: string + format: date-time + readOnly: true + example: null + nullable: true + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipientSentOnStatus' + TransactionalEmailRecipientClickedLink: + properties: + url: + type: string + format: uri + readOnly: true + example: https://example.com + clickedOn: + type: string + format: date-time + readOnly: true + example: 2019-06-02T09:31:20+0200 + type: object + TransactionalEmailRecipientDetails: + properties: + statuses: + $ref: '#/components/schemas/TransactionalEmailRecipientStatuses' + clickedLinks: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipientClickedLink' + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipient' + TransactionalEmailRecipientsDetails: + required: + - to + properties: + to: + $ref: '#/components/schemas/TransactionalEmailRecipientDetails' + cc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipientDetails' + bcc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipientDetails' + type: object + TransactionalEmailDetails: + required: + - transactionalEmailId + - fromField + - subject + - recipients + properties: + fromField: + description: The 'From' address ID to be used as the message sender + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The 'From' address ID to be used as the Reply-to + allOf: + - $ref: '#/components/schemas/FromFieldReference' + subject: + type: string + maxLength: 512 + minLength: 1 + example: Order Confirmation - Example Shop + tag: + description: The tag ID used for statistical data collection + allOf: + - $ref: '#/components/schemas/TransactionalEmailTag' + recipients: + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipientsDetails' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api3.getresponse360.com/v3/transactional-emails/tRe4i + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmail' + TransactionalEmailTag: + required: + - tagId + properties: + tagId: + type: string + example: vBd5 + type: object + TransactionalEmailRecipientSentOnStatus: + properties: + sentOn: + type: string + format: date-time + readOnly: true + example: 2019-06-02T09:30:43+0200 + nullable: true + type: object + TransactionalEmailListElement: + required: + - transactionalEmailId + - recipients + - fromField + - subject + properties: + transactionalEmailId: + type: string + readOnly: true + example: tRe4i + fromField: + $ref: '#/components/schemas/FromFieldReference' + recipients: + allOf: + - required: + - to + properties: + to: + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipient' + - properties: + statuses: + $ref: >- + #/components/schemas/TransactionalEmailRecipientSentOnStatus + type: object + type: object + subject: + type: string + maxLength: 512 + minLength: 1 + example: Order Confirmation - Example Shop + tag: + $ref: '#/components/schemas/TransactionalEmailTag' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api3.getresponse360.com/v3/transactional-emails/tRe4i + type: object + TransactionalEmailStatistics: + properties: + timeFrame: + description: >- + The statistics time frame in the ISO 8601 date format with duration + interval + type: string + pattern: >- + /^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?(\/)P(?=\w*\d)(?:\d+Y|Y)?(?:\d+M|M)?(?:\d+W|W)?(?:\d+D|D)?(?:T(?:\d+H|H)?(?:\d+M|M)?(?:\d+(?:\­.\d{1,2})?S|S)?)?$/ + example: 2014-09-20T00:00:00+0000/P2M18DT10H0M0S + sent: + type: integer + format: int64 + opened: + type: integer + format: int64 + bounced: + type: integer + format: int64 + complaint: + type: integer + format: int64 + type: object + TransactionalEmail: + properties: + transactionalEmailId: + type: string + readOnly: true + example: tRe4i + type: object + FromField: + properties: + fromFieldId: + description: The 'From' address ID + type: string + readOnly: true + example: TTzW + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/TTzW + email: + description: The email address + type: string + format: email + example: jsmith@example.com + rewrittenEmail: + description: Email address used to send message. + type: string + format: email + example: jsmith@example.com + nullable: true + name: + description: The name connected to the email address + type: string + maxLength: 64 + minLength: 2 + example: John Smith + isActive: + description: Flag if the 'From' address is active + readOnly: true + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + isDefault: + description: Flag if the 'From' address is default for the account + readOnly: true + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + domain: + properties: + status: + description: Status of domain + type: string + enum: + - confirmed + - unconfirmed + - deleted + - can_not_be_used + - dns_configuration_pending + nullable: true + DKIMWarning: + description: DKIM warning status + type: string + enum: + - not_recommended + - can_not_be_used + - not_authenticated + - at_risk + nullable: true + type: object + type: object + NewFromField: + required: + - email + - name + type: object + allOf: + - $ref: '#/components/schemas/FromField' + FromFieldReference: + required: + - fromFieldId + properties: + fromFieldId: + description: The 'From' address ID + type: string + example: V + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/V + type: object + RssNewsletterDetails: + properties: + clickTracks: + description: The list of tracked links + type: array + items: + $ref: '#/components/schemas/ClickTrack' + flags: + $ref: '#/components/schemas/MessageFlagsArray' + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletter' + RssNewsletterListItem: + properties: + flags: + $ref: '#/components/schemas/MessageFlagsString' + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterListing' + RssNewsletterSendSettingsListing: + required: + - frequency + - filter + properties: + frequency: + description: When to send the message + type: string + example: asap + filter: + description: The filter settings for an RSS post + type: string + enum: + - recent + - engaged + - shared + - commented + maxArticles: + description: How many articles to display in a list + type: integer + format: int32 + maximum: 30 + minimum: 1 + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSuppressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + discriminator: + propertyName: frequency + mapping: + asap: '#/components/schemas/RssNewsletterListSendAsapSettings' + daily: '#/components/schemas/RssNewsletterListSendDailySettings' + weekly: '#/components/schemas/RssNewsletterListSendWeeklySettings' + monthly: '#/components/schemas/RssNewsletterListSendMonthlySettings' + RssNewsletterListSendAsapSettings: + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + RssNewsletterListSendDailySettings: + required: + - sendAtHour + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + RssNewsletterListSendWeeklySettings: + required: + - sendAtHour + - sendAtWeekDay + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + sendAtWeekDay: + description: The day of the week when the message should be sent + type: string + enum: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + RssNewsletterListSendMonthlySettings: + required: + - sendAtHour + - sendAtMonthDay + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + minimum: 0 + sendAtMonthDay: + description: >- + The day of the month when the message should be sent or 31 + representing last day of month + type: integer + format: int32 + maximum: 28 + minimum: 1 + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + RssNewsletterListing: + required: + - rssNewsletterId + - href + properties: + rssNewsletterId: + description: The RSS newsletter ID + type: string + readOnly: true + example: dGer + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/rss-newsletters/dGer + rssFeedUrl: + description: The URL for the RSS Feed + type: string + format: uri + example: http://blog.getresponse.com + subject: + description: The RSS message subject + type: string + maxLength: 255 + minLength: 1 + example: My rss to newsletters + name: + description: How your newsletters will be seen inside the application + type: string + maxLength: 255 + minLength: 1 + example: rsstest0 + status: + description: The status of the RSS newsletter + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + editor: + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + fromField: + description: The 'From' email address used for the message + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The email that will be used as a reply-to address + allOf: + - $ref: '#/components/schemas/FromFieldReference' + content: + $ref: '#/components/schemas/MessageContent' + sendSettings: + description: How the message will be delivered to the subscriber + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + MessageSendSettingSelectedCampaigns: + description: The list of campaign IDs to choose subscribers from. + items: + type: string + example: C + MessageSendSettingSelectedSegments: + description: The list of segment IDs to choose subscribers from. + items: + type: string + example: Se + MessageSendSettingSelectedSuppressions: + description: The list of suppression IDs to exclude subscribers. + items: + type: string + example: Ss + MessageSendSettingExcludedCampaigns: + description: The list of campaign IDs to exclude subscribers. + items: + type: string + example: eC + MessageSendSettingExcludedSegments: + description: The list of segment IDs to exclude subscribers. + items: + type: string + example: eSs + MessageSendSettingSelectedContacts: + description: The list of selected contacts. + items: + type: string + example: eSs + BaseCampaign: + properties: + campaignId: + description: Campaign ID + type: string + readOnly: true + example: V3J + name: + description: >- + The campaign (list) name. + + + * You can use each list name just once in your account. + + + * The name must be between 3-64 characters. + + + * All alphabets supported by GetResponse, including right-to-left + ones, are allowed. + + + * You can use upper and lower case letters, numbers, spaces and + special characters apart from the ones listed below. + + + * You can’t use emojis and the following special characters: `/`, + `\`, `@`, and `[` or `]`. + type: string + maxLength: 64 + minLength: 3 + example: my_campaign + techName: + description: >- + Tech name is a unique internal ID of a list used for [FTP + imports](https://www.getresponse.com/help/how-to-import-files-via-ftp.html) + (available in GetResponse MAX accounts only) + type: string + readOnly: true + example: my_campaign + languageCode: + description: >- + The campaign language code according to ISO 639-1, plus: zt - + Chinese (Traditional), fs - Afghan Persian (Dari), md - Moldavian + type: string + example: EN + isDefault: + description: Is the campaign default + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + createdOn: + description: The date of creation + type: string + format: date-time + readOnly: true + example: 2014-02-12T15:19:21+0000 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/campaigns/V3J + type: object + CampaignAdditionalProperties: + properties: + postal: + $ref: '#/components/schemas/CampaignPostal' + confirmation: + $ref: '#/components/schemas/CampaignConfirmation' + optinTypes: + $ref: '#/components/schemas/CampaignOptinTypes' + subscriptionNotifications: + $ref: '#/components/schemas/CampaignSubscriptionNotifications' + profile: + $ref: '#/components/schemas/CampaignProfile' + type: object + Campaign: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseCampaign' + - $ref: '#/components/schemas/CampaignAdditionalProperties' + NewCampaign: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/Campaign' + UpdateCampaign: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/Campaign' + CampaignConfirmation: + properties: + fromField: + $ref: '#/components/schemas/FromFieldReference' + redirectType: + description: >- + What will happen after email confirmation. The values allowed + include: hosted (the subscriber will stay on the default GetResponse + website), customUrl (the subscriber will be redirected to a custom + URL provided by the user). + type: string + enum: + - hosted + - customUrl + example: hosted + mimeType: + description: The MIME type for the confirmation message + type: string + enum: + - text/html + - text/plain + - combo + example: text/plain + redirectUrl: + description: >- + Required if the redirectType is customUrl. The URL a subscriber will + be redirected to if the redirectType is set to customUrl. + type: string + format: uri + example: http://example.com + replyTo: + $ref: '#/components/schemas/FromFieldReference' + subscriptionConfirmationBodyId: + description: The subscription confirmation body ID + type: string + example: asS1 + subscriptionConfirmationSubjectId: + description: Subscription confirmation subject ID + type: string + example: TEww + type: object + CampaignOptinTypes: + properties: + email: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + - double + example: single + api: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + - double + example: single + import: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + example: single + webform: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + - double + example: single + type: object + CampaignPostal: + properties: + addPostalToMessages: + description: >- + Should the postal address be included in all message footers for + this campaign (mandatory for Canada and the US) + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + city: + description: The city, free-text + type: string + example: London + companyName: + description: The company name, free-text + type: string + example: Company Ltd. + country: + description: The country name, free-text + type: string + example: Great Britain + design: + description: >- + How the postal address will display in messages. The available + fields include: [[name]], [[address]], [[city]], [[state]] [[zip]], + [[country]] + type: string + example: '[[name]] from [[city]] in [[country]]' + state: + description: The state, free-text + type: string + example: Shire + street: + description: The street, free-text + type: string + example: Bilbo Baggins Av + zipCode: + description: The ZIP code + type: string + example: 81-611 + type: object + CampaignProfile: + properties: + description: + description: The campaign description + type: string + maxLength: 255 + minLength: 2 + example: campaign description + industryTagId: + description: The industry tag ID + type: string + format: integer + example: '1' + logo: + description: The logo URL + type: string + format: uri + example: http://logos.com/imageupdated.jpg + logoLinkUrl: + description: The logo link URL + type: string + format: uri + example: http://somePageLogoLinkUpdated.com + title: + description: The profile title + type: string + maxLength: 64 + minLength: 2 + example: title + type: object + CampaignSubscriptionNotifications: + properties: + status: + description: >- + Are notifications enabled. Possible values include: enabled, + disabled. + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + recipients: + type: array + items: + $ref: '#/components/schemas/FromFieldReference' + type: object + UpdateAccount: + type: object + allOf: + - $ref: '#/components/schemas/Account' + Account: + properties: + accountId: + description: Account ID + type: string + readOnly: true + example: VfEy1 + email: + description: Email + type: string + format: email + readOnly: true + example: john.smith@test.com + countryCode: + readOnly: true + $ref: '#/components/schemas/AccountDetailsCountryCode' + industryTag: + readOnly: true + $ref: '#/components/schemas/IndustryTagId' + timeZone: + readOnly: true + allOf: + - $ref: '#/components/schemas/TimezoneName' + - $ref: '#/components/schemas/TimezoneOffset' + href: + description: Direct URL to resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/accounts + firstName: + description: First name + type: string + maxLength: 64 + minLength: 2 + example: John + lastName: + description: Last name + type: string + maxLength: 64 + minLength: 2 + example: Smith + companyName: + description: Company name + type: string + maxLength: 64 + minLength: 2 + example: MyBigCompany + phone: + description: Phone number + type: string + maxLength: 32 + minLength: 2 + example: '+00155555555' + state: + description: State + type: string + maxLength: 40 + minLength: 2 + example: Oklahoma + city: + description: City + type: string + example: Alderson + street: + description: Street + type: string + maxLength: 64 + minLength: 2 + example: Sunset blv. + zipCode: + description: ZIP Code + type: string + maxLength: 9 + minLength: 2 + example: 81-611 + numberOfEmployees: + description: Numbers of employees + type: string + enum: + - '50' + - '250' + - '500' + - more + example: '500' + timeFormat: + description: Account time notation + type: string + enum: + - 12h + - 24h + example: 24h + type: object + AutoresponderTriggerSettings: + required: + - type + - dayOfCycle + - selectedCampaigns + properties: + type: + description: The trigger type + type: string + items: + type: string + enum: + - onday + default: onday + dayOfCycle: + description: >- + For onday type the day of the autoresponder cycle in the 0-9999 + format + type: integer + format: int32 + maximum: 9999 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + autoresponder: + type: string + readOnly: true + nullable: true + newsletter: + type: string + readOnly: true + nullable: true + clickTrackId: + type: string + readOnly: true + nullable: true + goal: + type: string + readOnly: true + nullable: true + custom: + type: string + readOnly: true + nullable: true + newCustomValue: + type: string + readOnly: true + nullable: true + action: + type: string + readOnly: true + nullable: true + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + type: object + AutoresponderSendSettings: + required: + - type + properties: + type: + description: When to send the message + type: string + enum: + - signup + - immediately + - delay + - custom + delayInHours: + description: >- + How many hours to delay the message after a trigger occured, in the + 0-23 format + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + sendAtHour: + description: >- + The specific hour on which the message will be sent, in the 0-23 + format + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + recurrence: + description: >- + Should the message be sent every time the trigger occurs (example: + each click) + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + timeTravel: + description: >- + Should the message be sent in the user's or the subscriber's time + zone + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + excludedDaysOfWeek: + description: >- + The days of the week to exclude from message sending (the message + will be sent on the next non-excluded day after the trigger) + type: array + items: + type: string + enum: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + externalLexpad: + description: >- + External Lexpad settings for the message, read more: [External + Lexpad](https://apidocs.getresponse.com/v3/dynamic-content/external-lexpad) + nullable: true + allOf: + - $ref: '#/components/schemas/ExternalLexpad' + type: object + discriminator: + propertyName: type + mapping: + signup: '#/components/schemas/AutoresponderSendSignupSettings' + immediately: '#/components/schemas/AutoresponderSendImmediatelySettings' + delay: '#/components/schemas/AutoresponderSendDelaySettings' + custom: '#/components/schemas/AutoresponderSendCustomSettings' + AutoresponderSendSignupSettings: + type: object + allOf: + - $ref: '#/components/schemas/AutoresponderSendSettings' + AutoresponderSendImmediatelySettings: + type: object + allOf: + - $ref: '#/components/schemas/AutoresponderSendSettings' + AutoresponderSendDelaySettings: + required: + - delayInHours + type: object + allOf: + - $ref: '#/components/schemas/AutoresponderSendSettings' + AutoresponderSendCustomSettings: + required: + - sendAtHour + type: object + allOf: + - $ref: '#/components/schemas/AutoresponderSendSettings' + Autoresponder: + required: + - autoresponderId + - href + properties: + autoresponderId: + description: The autoresponder ID + type: string + readOnly: true + example: Q + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/autoresponders/Q + name: + description: The autoresponder name + type: string + maxLength: 128 + minLength: 2 + example: Message 2 + subject: + description: The autoresponder message subject + type: string + maxLength: 128 + minLength: 2 + example: test12 + campaignId: + description: >- + The campaign ID. The system will assign the autoresponder to a + default campaign if you don't provide a specific campaign ID. + type: string + example: V + status: + description: The autoresponder status + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + editor: + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + fromField: + description: The from email address used for the message + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The email that will be used as a reply-to address + allOf: + - $ref: '#/components/schemas/FromFieldReference' + content: + $ref: '#/components/schemas/MessageContent' + flags: + $ref: '#/components/schemas/MessageFlagsArray' + sendSettings: + description: How the message will be delivered to the subscriber + allOf: + - $ref: '#/components/schemas/AutoresponderSendSettings' + triggerSettings: + description: 'The conditions that will trigger the autoresponder ' + allOf: + - $ref: '#/components/schemas/AutoresponderTriggerSettings' + statistics: + description: The autoresponder statistics summary + type: object + readOnly: true + allOf: + - properties: + delivered: + type: number + format: float + example: '0' + openRate: + type: number + format: float + example: '0' + clickRate: + type: number + format: float + example: '0' + type: object + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + NewAutoresponder: + required: + - status + - subject + - content + - sendSettings + - triggerSettings + type: object + allOf: + - $ref: '#/components/schemas/Autoresponder' + UpdateAutoresponder: + type: object + allOf: + - $ref: '#/components/schemas/Autoresponder' + RssNewsletterSendSettingsDetails: + required: + - frequency + - filter + properties: + frequency: + description: When to send the message + type: string + example: asap + filter: + description: The filter settings for an RSS post + type: string + enum: + - recent + - engaged + - shared + - commented + maxArticles: + description: How many articles to display in a list + type: integer + format: int32 + maximum: 30 + exclusiveMaximum: false + minimum: 1 + exclusiveMinimum: false + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSuppressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + selectedContacts: + $ref: '#/components/schemas/MessageSendSettingSelectedContacts' + type: object + discriminator: + propertyName: frequency + mapping: + asap: '#/components/schemas/RssNewsletterSendAsapSettings' + daily: '#/components/schemas/RssNewsletterSendDailySettings' + weekly: '#/components/schemas/RssNewsletterSendWeeklySettings' + monthly: '#/components/schemas/RssNewsletterSendMonthlySettings' + RssNewsletterSendAsapSettings: + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + RssNewsletterSendDailySettings: + required: + - sendAtHour + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + RssNewsletterSendWeeklySettings: + required: + - sendAtHour + - sendAtWeekDay + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + sendAtWeekDay: + description: The day of the week when the message should be sent + type: string + enum: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + RssNewsletterSendMonthlySettings: + required: + - sendAtHour + - sendAtMonthDay + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + sendAtMonthDay: + description: >- + The day of the month when the message should be sent or 31 + representing last day of month + type: integer + format: int32 + oneOf: + - description: Days available for every month + maximum: 28 + minimum: 1 + - description: >- + Represents the last day of month, even if it has less then 31 + days + enum: + - 31 + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + RssNewsletter: + required: + - rssNewsletterId + - href + properties: + rssNewsletterId: + description: The RSS newsletter ID + type: string + readOnly: true + example: dGer + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/rss-newsletters/dGer + rssFeedUrl: + description: The URL for the RSS Feed + type: string + format: uri + example: http://blog.getresponse.com + subject: + description: The RSS message subject + type: string + maxLength: 255 + minLength: 1 + example: My rss to newsletters + name: + description: How your newsletters will be seen inside the application + type: string + maxLength: 255 + minLength: 1 + example: rsstest0 + status: + description: The status of the RSS newsletter + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + editor: + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + fromField: + description: The 'From' email address used for the message + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The email that will be used as a reply-to address + allOf: + - $ref: '#/components/schemas/FromFieldReference' + content: + $ref: '#/components/schemas/MessageContent' + sendSettings: + description: How the message will be delivered to the subscriber + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + NewRssNewsletter: + required: + - rssFeedUrl + - subject + - status + - fromField + - content + - sendSettings + properties: + flags: + $ref: '#/components/schemas/MessageFlagsArray' + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletter' + UpdateRssNewsletter: + properties: + flags: + $ref: '#/components/schemas/MessageFlagsArray' + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletter' + MessageFlagsArray: + description: The message flags. + type: array + items: + type: string + enum: + - openrate + - clicktrack + - google_analytics + MessageFlagsString: + description: >- + Comma-separated list of message flags. The possible values are: + `openrate`, `clicktrack`, and `google_analytics`. + type: string + example: openrate,clicktrack,google_analytics + MessageEditorEnum: + description: >- + How the message was created: `custom` means a custom-made message, + `text` means plain text content, `getresponse` means that the message + was created using the GetResponse editor. + type: string + enum: + - custom + - text + - getresponse + - legacy + - html2 + MessageContent: + description: The message content. + properties: + html: + description: The message content in HTML + type: string + maxLength: 524288 + example: >- +

test 12

Some test http://example.com

+ plain: + description: The plain text equivalent of the message content + type: string + maxLength: 524288 + example: test 12 Some test + type: object + Contact: + required: + - contactId + - href + - email + properties: + contactId: + type: string + readOnly: true + example: pV3r + name: + type: string + maxLength: 128 + minLength: 1 + example: John Doe + origin: + type: string + enum: + - import + - email + - www + - panel + - leads + - sale + - api + - forward + - survey + - iphone + - copy + - landing_page + - website_builder_elegant + readOnly: true + timeZone: + description: >- + The time zone of a contact, uses the time zone database format + (https://www.iana.org/time-zones) + type: string + readOnly: true + example: Europe/Warsaw + activities: + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/contacts/pV3r/activities + changedOn: + type: string + format: date-time + readOnly: true + example: 2017-12-19T13:11:48+0000 + createdOn: + type: string + format: date-time + readOnly: true + example: 2017-03-02T07:30:49+0000 + campaign: + type: object + $ref: '#/components/schemas/CampaignReference' + email: + type: string + format: email + example: john.doe@example.com + dayOfCycle: + description: >- + The day on which the contact is in the Autoresponder cycle. `null` + indicates the contacts is not in the cycle. + type: string + example: '42' + nullable: true + scoring: + description: Contact scoring, pass null to remove the score from a contact + type: number + example: 8 + nullable: true + engagementScore: + description: >- + Engagement Score is a feature that presents a visual estimate of a + contact's engagement with mailings. The score is based on the + contact's interactions with your e-mails. Via API, it's returned in + the form of numbers ranging from 1 (Not Engaged) to 5 (Highly + Engaged). + type: integer + format: int32 + maximum: 5 + minimum: 1 + readOnly: true + example: 3 + nullable: true + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/contacts/pV3r + type: object + NewContactCustomFieldValue: + required: + - customFieldId + - value + properties: + customFieldId: + description: Custom field ID + type: string + example: kL6Nh + value: + type: array + items: + type: string + example: 18-35 + type: object + NewContactTag: + required: + - tagId + properties: + tagId: + type: string + example: m7E2 + type: object + ContactTag: + properties: + tagId: + type: string + example: hR + name: + type: string + example: super_promo + href: + type: string + format: uri + example: https://api.getresponse.com/v3/tags/hR + color: + type: string + deprecated: true + type: object + NewContactTags: + properties: + tags: + type: array + items: + $ref: '#/components/schemas/NewContactTag' + type: object + NewContactCustomFieldValues: + properties: + customFieldValues: + type: array + items: + $ref: '#/components/schemas/NewContactCustomFieldValue' + type: object + NewContact: + required: + - email + - campaign + type: object + allOf: + - $ref: '#/components/schemas/Contact' + - properties: + ipAddress: + description: The contact's IP address. IPv4 and IPv6 formats are accepted. + example: 1.2.3.4 + oneOf: + - type: string + format: ipv4 + - type: string + format: ipv6 + type: object + - $ref: '#/components/schemas/NewContactTags' + - $ref: '#/components/schemas/NewContactCustomFieldValues' + UpsertContactCustomFields: + required: + - customFieldValues + type: object + allOf: + - $ref: '#/components/schemas/NewContactCustomFieldValues' + UpsertContactTags: + required: + - tags + type: object + allOf: + - $ref: '#/components/schemas/NewContactTags' + UpdateContact: + type: object + allOf: + - $ref: '#/components/schemas/Contact' + - properties: + note: + type: string + maxLength: 255 + minLength: 0 + nullable: true + type: object + - $ref: '#/components/schemas/NewContactTags' + - $ref: '#/components/schemas/NewContactCustomFieldValues' + CustomFieldTypeEnum: + type: string + enum: + - text + - textarea + - radio + - checkbox + - single_select + - multi_select + - number + - date + - datetime + - country + - currency + - phone + - gender + - ip + - url + CustomFieldFormatEnum: + type: string + enum: + - text + - textarea + - radio + - checkbox + - single_select + - multi_select + CustomField: + properties: + customFieldId: + description: Custom field ID + type: string + readOnly: true + example: pas + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/custom-fields/pas + name: + description: >- + The name of the custom field. It must meet the following + requirements: + * be unique + * use only lowercase letters, underscores and digits + * not be equal to one of the merge words used in messages, i.e. `name, email, twitter, facebook, buzz, myspace, linkedin, digg, googleplus, pinterest, responder, campaign, change`. + type: string + maxLength: 128 + minLength: 1 + example: office_phone_number + type: + description: |- + The custom field `type` accepts the following values: + * `text` - text input (doesn't require values in the `values` field, you can pass empty array) + * `textarea` - textarea input (does n't require values in the `values` field, you can pass empty array) + * `radio` - radio input (requires at least 2 values in the `values` field) + * `checkbox` - checkbox input (requires at least 2 values in the `values` field) + * `single_select` - single select input (requires at least 2 values in the `values` field) + * `multi_select` - multi select input (requires at least 2 values in the `values` field) + * `number` - text input for a numeric value (doesn't require values in the `values` field, you can pass empty array) + * `date` - text input for a date (doesn't require values in the `values` field, you can pass empty array) + * `datetime` - text input for date and time (doesn't require values in the `values` field, you can pass empty array) + * `country` - multi select input for a country (requires at least 2 country names in the `values` field) + * `currency` - multi select for a currency, allows all ISO 4217 currency codes (requires at least 2 currency codes in the `values` field) + * `phone` - text input for a phone number (doesn't require values in the `values` field, you can pass empty array) + * `gender` - radio input for gender (requires 2 values in the `values` field: `Male` and `Female`, that can be translated into one of the languages supported by GetResponse) + * `ip` - text input for an IP address (doesn't require values in the `values` field, you can pass empty array) + * `url` - text input for a URL (doesn't require values in the `values` field, you can pass empty array). + example: phone + allOf: + - $ref: '#/components/schemas/CustomFieldTypeEnum' + valueType: + description: >- + Type of returning value, it returns `format` options extended by a + `string` option if the `format` was not defined + type: string + enum: + - string + - number + - date + - datetime + - country + - currency + - phone + - gender + - ip + - url + readOnly: true + example: phone + format: + description: |- + The custom field `format` accepts following values: + * `text` - text input (doesn't require values in the `values` field, you can pass empty array) + * `textarea` - textarea input (doesn't require values in the `values` field, you can pass empty array) + * `radio` - radio input (requires at least 2 values in the `values` field) + * `checkbox` - checkbox input (requires at least 2 values in the `values` field) + * `single_select` - single select input (requires at least 2 values in the `values` field) + * `multi_select` - multi select input (requires at least 2 values in the `values` field). + example: text + allOf: + - $ref: '#/components/schemas/CustomFieldFormatEnum' + fieldType: + description: Returns the same data as `type` + type: string + readOnly: true + example: text + deprecated: true + hidden: + description: Whether the custom field is visible to contacts + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + values: + description: >- + The list of assigned values (zero or more - depending on the custom + field type. Please see description) + type: array + items: + type: string + example: '+48600100200' + type: object + NewCustomField: + required: + - name + - type + - hidden + - values + type: object + allOf: + - $ref: '#/components/schemas/CustomField' + UpdateCustomField: + required: + - hidden + - values + properties: + hidden: + description: Whether the custom field is visible to contacts + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + values: + description: >- + The list of assigned values (zero or more - depending on the custom + field type. Please see description) + type: array + items: + type: string + example: '+48600100200' + type: object + NewSuppression: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseSuppression' + UpdateSuppression: + required: + - name + - masks + type: object + allOf: + - $ref: '#/components/schemas/BaseSuppression' + NewPredefinedField: + required: + - name + - value + - campaign + type: object + allOf: + - $ref: '#/components/schemas/PredefinedField' + UpdatePredefinedField: + required: + - value + properties: + value: + type: string + maxLength: 350 + minLength: 1 + pattern: ^[A-Za-z_]{1,350}$ + example: my_new_value + type: object + UpdateCallbacks: + properties: + url: + description: >- + URL to use to post notifications, required if callbacks are not yet + enabled + type: string + format: uri + example: https://example.com/callback + actions: + type: object + $ref: '#/components/schemas/CallbackActions' + type: object + TriggerCustomEvent: + required: + - name + - contactId + properties: + name: + description: >- + The name of custom event. Custom event with this name must already + exist + type: string + maxLength: 64 + minLength: 3 + pattern: ^[a-z0-9_]{3,64}$ + example: lesson_finished + contactId: + description: The contact ID + type: string + example: lTgH5 + attributes: + description: The attributes for the trigger + type: array + items: + $ref: '#/components/schemas/TriggerCustomEventAttribute' + type: object + TriggerCustomEventAttribute: + required: + - name + - value + properties: + name: + description: >- + The name of the attribute. It must be already defined for the custom + event + type: string + maxLength: 64 + minLength: 3 + example: lesson_name + value: + example: lesson_3 + $ref: '#/components/schemas/TriggerCustomEventAttributeValue' + type: object + TriggerCustomEventAttributeValue: + description: >- + The value of the attribute. Value type depends on the attribute + definition + oneOf: + - type: string + maxLength: 255 + minLength: 1 + example: lesson_3 + - $ref: '#/components/schemas/StringBooleanEnum' + - type: boolean + - description: 'Date in extended ISO 8601 datetime format: *2019-01-01T08:00:00+00*' + type: string + format: date-time + example: 2019-01-01T08:00:00+0000 + - type: integer + format: int64 + example: 1500 + NewCustomEvent: + type: object + allOf: + - $ref: '#/components/schemas/CustomEvent' + UpdateCustomEvent: + type: object + allOf: + - $ref: '#/components/schemas/CustomEvent' + CustomEvent: + required: + - name + - attributes + properties: + name: + description: Unique name of custom event + type: string + pattern: ^[a-z0-9_]{3,64}$ + example: sample_custom_event + attributes: + description: Optional collection of attributes + type: array + items: + $ref: '#/components/schemas/CustomEventAttributeDetails' + type: object + CustomEventDetails: + required: + - customEventId + - createdOn + properties: + customEventId: + description: The custom event ID + type: string + readOnly: true + example: hy7 + createdOn: + description: Date of creation custom event definition + type: string + format: date-time + readOnly: true + example: 2019-08-19T11:32:34+0000 + href: + description: Direct hyperlink to a resource + type: string + format: url + readOnly: true + example: https://api.getresponse.com/v3/custom-events/vBd5 + type: object + allOf: + - $ref: '#/components/schemas/CustomEvent' + CustomEventAttributeDetails: + required: + - customEventAttributeId + properties: + customEventAttributeId: + type: string + readOnly: true + example: gt7 + type: object + allOf: + - $ref: '#/components/schemas/CustomEventAttribute' + CustomEventAttribute: + required: + - name + - type + properties: + name: + description: Unique name of attribute + type: string + pattern: ^[a-z0-9_]{3,64}$ + example: sample_attribute + type: + description: Type of attribute + enum: + - string + - number + - datetime + - boolean + example: string + type: object + FormVariant: + properties: + variant: + description: The index of variants + type: string + readOnly: true + example: '0' + variantName: + type: string + example: Variant A + winner: + description: Is this variant the winner in the A/B test + $ref: '#/components/schemas/StringBooleanEnum' + status: + type: string + enum: + - published + - unpublished + - disabled + createdOn: + type: string + format: date-time + example: 2018-07-11T13:37:25+0000 + statistics: + $ref: '#/components/schemas/FormStatistics' + type: object + FormVariantDetails: + properties: + formId: + type: string + readOnly: true + example: pL4e + webformId: + description: Same as `formId` + type: string + readOnly: true + example: pL4e + variant: + description: The index of variants + type: string + readOnly: true + example: '0' + variantName: + type: string + example: Variant A + winner: + description: Is this variant the winner in the A/B test + type: string + enum: + - 'yes' + - 'no' + status: + type: string + enum: + - published + - unpublished + - disabled + createdOn: + type: string + format: date-time + example: 2018-07-09T15:45:12+0000 + numberOfVisitors: + description: The total number of form visitors + type: integer + format: int64 + example: 152 + numberOfUniqueVisitors: + description: The number of unique form visitors + type: integer + format: int64 + example: 136 + numberOfSubscribers: + description: The number of visitors who subscribed through this form + type: integer + format: int64 + example: 94 + subscriptionRate: + description: The ratio of `numberOfSubscribers` to `numberOfVisitors` + type: number + format: double + example: 0.62 + type: object + FormDetails: + type: object + allOf: + - $ref: '#/components/schemas/Form' + - properties: + settings: + $ref: '#/components/schemas/FormSettings' + variants: + type: array + items: + $ref: '#/components/schemas/FormVariant' + type: object + FormSettings: + properties: + optin: + description: >- + `single` - Single opt-in means that the contact will be added + without confirming their subscription first. `double` - Double + opt-in means that the contact will receive a subscription + confirmation email. + type: string + enum: + - single + - double + example: single + phase: + description: >- + The contact who subscribed via this form will be added to the + selected day in the autoresponder cycle. If null, the contact won't + be added to the cycle. + type: integer + format: int32 + maximum: 9999 + minimum: 0 + example: 5 + nullable: true + thankYouType: + description: What should happen when a new contact subscribes via the form. + type: string + enum: + - stay_on_page + - default + - custom_url + example: stay_on_page + thankYouUrl: + description: >- + The URL used to redirect the newly subscribed contacts when they + complete this form. Used if `thankYouType` is `custom_url`. + type: string + format: uri + example: https://example.com/thank-you + nullable: true + alreadySubscribedType: + description: What to do when the address already exists in the campaign + type: string + enum: + - stay_on_page + - default + - custom_url + example: stay_on_page + alreadySubscribedUrl: + description: >- + The URL used to redirect the already subscribed contacts when they + complete this form. Used if `alreadySubscribedType` is `custom_url`. + type: string + format: uri + example: https://example.com/thank-you + nullable: true + secondStageCaptcha: + description: Is captcha enabled for the form + $ref: '#/components/schemas/StringBooleanEnum' + forwardDataRequestType: + description: >- + How to forward form data to a thank-you page. [Learn + more](https://www.getresponse.com/help/building-contact-lists/forms-and-pop-ups/can-i-forward-subscriber-data-to-a-custom-thank-you-page.html). + `null` means that the data forwarding is turned off. + type: string + enum: + - GET + - POST + nullable: true + trackingCustomField: + description: >- + Subscribers added via this form will have this custom field set with + a value passed in `trackingCustomFieldValue` + type: string + nullable: true + $ref: '#/components/schemas/CustomFieldReference' + trackingCustomFieldValue: + description: See the `trackingCustomField` description + type: string + example: '123' + nullable: true + type: object + Form: + properties: + formId: + type: string + readOnly: true + example: pL4e + webformId: + description: Same as `formId` + type: string + readOnly: true + example: pL4e + name: + type: string + example: My first form + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/forms/pL4e + hasVariants: + description: Indicates if the form has variants (A/B tests) + type: boolean + readOnly: true + example: true + scriptUrl: + description: >- + The URL to a JavaScript file of the form. This is used to embed the + form within a web page. + type: string + format: uri + readOnly: true + example: >- + https://app.getresponse.com/view_webform_v2.js?u=nTfa&webforms_id=123 + status: + type: string + enum: + - published + - unpublished + - draft + example: published + createdOn: + type: string + format: date-time + example: 2018-07-02T11:22:33+0000 + statistics: + $ref: '#/components/schemas/FormStatistics' + campaign: + $ref: '#/components/schemas/CampaignReference' + type: object + FormStatistics: + properties: + visitors: + description: The total number of form visitors + type: integer + format: int64 + example: 4371 + uniqueVisitors: + description: The number of unique form visitors + type: integer + format: int64 + example: 3865 + subscribed: + description: The number of visitors that subscribed using this form + type: integer + format: int64 + example: 2594 + subscriptionRate: + description: The ratio of `subscribed` to `visitors` + type: number + format: double + example: 0.59 + type: object + BaseLandingPage: + properties: + landingPageId: + description: The landing page ID + type: string + example: avYn + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/landing-pages/avYn + metaTitle: + description: The landing page meta title property + type: string + example: Some meta title + domain: + description: The domain where the landing page is hosted + type: string + example: gr8.new + subdomain: + description: The subdomain where the landing page is assigned + type: string + example: summer-sale + userDomain: + description: The private domain provided by the user + type: string + example: '' + userDomainPath: + description: The private domain path provided by the user + type: string + example: '' + campaign: + description: The campaign to which the landing page is linked + allOf: + - $ref: '#/components/schemas/CampaignReference' + status: + description: The landing page status + allOf: + - $ref: '#/components/schemas/StatusEnum' + userDomainStatus: + description: >- + The DNS status for the user's private domain. Can be `null` if a + private domain isn't assigned. + type: string + enum: + - active + - inactive + - waiting + nullable: true + testAB: + description: Does the landing page have AB testing (variants) enabled + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + updatedOn: + description: The date of the last page update + type: string + format: date-time + readOnly: true + type: object + LandingPageVariant: + properties: + variantId: + description: The landing page variant ID. + type: string + example: PKxn + variant: + description: The variant index. + type: string + format: integer + example: '0' + winner: + type: boolean + example: true + visitors: + type: string + format: integer + example: '12' + uniqueVisitors: + type: string + format: integer + example: '2' + subscribed: + type: string + format: integer + example: '2' + type: object + LandingPage: + properties: + metaDescription: + description: The landing page meta description property + type: string + example: Some meta description + metaNoindex: + description: >- + To entirely prevent your page content from being listed in the + Google web index, even if other sites link to it use a noindex meta + tag + type: string + enum: + - 'yes' + - 'no' + dayOfCycle: + description: >- + Contacts subscribed via the landing page will be added to the + autoresponder cycle. `Null` if contacts shouldn't be added to the + cycle. + type: integer + format: int32 + maximum: 9999 + minimum: 0 + example: 2 + nullable: true + optin: + description: The opt-in type (double or single) + type: string + enum: + - single + - double + favicoUrl: + description: The favicon URL. Can be `null` if a favicon isn't present + type: string + format: uri + example: https://my-landing-page.mohahaha.com/favico.ico + nullable: true + thankYouPageType: + description: What should happen after a contact subscribes + type: string + enum: + - stay_on_page + - default + - custom_url + thankYouPageUrl: + description: >- + The `thank-you` page URL. Can be empty if a custom thank-you page + isn't being used + type: string + format: uri + example: https://my-landing-page.mohahaha.com/thank_you.html + url: + description: The landing page URL + type: string + format: uri + example: https://my-landing-page.mohahaha.com + variants: + type: array + items: + $ref: '#/components/schemas/LandingPageVariant' + type: object + allOf: + - $ref: '#/components/schemas/BaseLandingPage' + NewImport: + required: + - campaignId + - contacts + - fieldMapping + properties: + campaignId: + description: The ID of the destination campaign (list) + type: string + example: z5c + fieldMapping: + description: >- + Mapping definition for such contact properties as email address, + name, or custom fields. It's the equivalent of column headers in a + CSV file used to import contacts in a GetResponse account. The + `email` value is required. For custom fields, provide only custom + fields name in the mapping. Include their values in the + corresponding field in the contact array + type: array + items: + type: string + example: email + contacts: + description: >- + Container for a contact definition. Include the values defined in + the `fieldMapping` array + type: array + items: + $ref: '#/components/schemas/NewImportContact' + type: object + NewImportContact: + type: array + items: + type: string + example: example@somedomain.com + Import: + properties: + importId: + description: The import ID + type: string + readOnly: true + example: o6gE + campaign: + type: object + $ref: '#/components/schemas/CampaignReference' + status: + type: string + enum: + - uploaded + - review + - approved + - rejected + - finished + - canceled + - to_review + readOnly: true + statistics: + description: The import statistics + type: object + $ref: '#/components/schemas/ImportStatistics' + errorStatistics: + description: The detailed import error statistics + type: object + $ref: '#/components/schemas/ImportErrorStatistics' + createdOn: + type: string + format: date-time + finishedOn: + type: string + format: date-time + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/imports/o6gE + type: object + ImportStatistics: + required: + - uploaded + - invalid + - updated + - addedToList + properties: + uploaded: + description: The number of uploaded contacts + type: integer + format: int64 + readOnly: true + example: 25 + invalid: + description: The number of invalid contacts + type: integer + format: int64 + readOnly: true + example: 5 + updated: + description: The number of updated contacts + type: integer + format: int64 + readOnly: true + example: 10 + addedToList: + description: The number of added contacts + type: integer + format: int64 + readOnly: true + example: 10 + type: object + ImportErrorStatistics: + properties: + syntaxErrors: + description: The number of contacts with a syntax error + type: integer + format: int64 + readOnly: true + example: 2 + alreadyInQueue: + description: The number of contacts already in queue + type: integer + format: int64 + readOnly: true + example: 1 + invalidDomains: + description: The number of contacts with invalid domains + type: integer + format: int64 + readOnly: true + example: 1 + blacklist: + description: The number of blocked contacts + type: integer + format: int64 + readOnly: true + example: 1 + policyFailures: + description: The number of contacts rejected for policy reasons + type: integer + format: int64 + readOnly: true + example: 1 + mismatchedCriteria: + description: >- + The number of contacts rejected because of mismatched criteria, + [learn + more](https://www.getresponse.com/help/managing-contacts/working-with-contact-lists/where-can-i-find-import-statistics.html#what-do-the-numbers-for-uploaded-approved-and-import-errors-mean) + type: integer + format: int64 + readOnly: true + example: 1 + type: object + SmsStats: + required: + - smsId + properties: + smsId: + description: The SMS message ID + type: string + example: PvLI8C + totalSms: + description: The number of SMS messages sent + type: integer + example: 1 + totalRecipients: + description: The number of recipients + type: integer + example: 1 + totalClicks: + description: The number of link clicks from an SMS message + type: integer + example: 1 + totalUnsubscribes: + description: The number of opt-outs from an SMS message + type: integer + example: 1 + totalPrice: + description: Cost details of a specific SMS + type: object + nullable: false + allOf: + - properties: + amount: + description: Total SMS message cost + type: string + example: '0.0240' + currency: + description: Pricing currency + type: string + example: USD + type: object + link: + description: Link details + type: object + nullable: false + allOf: + - properties: + url: + description: Link URL + type: string + example: https://getresponse.com + clicks: + description: The number of link clicks from an SMS message + type: integer + example: 1 + type: object + countryStatistics: + description: SMS message statistics per country + type: object + nullable: false + allOf: + - properties: + countryCode: + description: Country code + type: string + example: PL + recipients: + description: The number of recipients + type: integer + example: 1 + smsCount: + description: The number of messages sent + type: integer + example: 1 + price: + description: Pricing details + type: object + allOf: + - properties: + price: + description: Total cost + type: string + example: '0.0240' + currency: + description: Pricing currency + type: string + example: USD + type: object + type: object + type: object + RevenueStatistics: + properties: + currency: + description: Statistics currency + type: string + example: USD + timeSeries: + type: array + items: + properties: + timeInterval: + description: >- + Orders and revenue are grouped by time intervals. Interval + length is set automatically and depends on the `orderDate` + parameter. + type: string + pattern: >- + /^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?(\/)P(?=\w*\d)(?:\d+Y|Y)?(?:\d+M|M)?(?:\d+W|W)?(?:\d+D|D)?(?:T(?:\d+H|H)?(?:\d+M|M)?(?:\d+(?:\­.\d{1,2})?S|S)?)?$/ + example: 2014-09-20T00:00:00+0000/P2M18DT10H0M0S + revenue: + description: Revenue + type: number + example: 2.45 + orders: + description: Number of orders + type: integer + example: 5 + type: object + type: object + GeneralPerformanceStats: + properties: + currency: + description: Statistics currency + type: string + example: USD + order: + description: Order statistics + type: object + nullable: false + allOf: + - properties: + orders: + description: Number of orders + type: integer + example: 5 + ordersTrend: + description: Order trend + type: number + example: 1.23 + avgOrderRevenue: + description: Average order value + type: number + example: 1.23 + avgOrderRevenueTrend: + description: Average order value trend + type: number + example: 1.23 + type: object + revenue: + description: Revenue statistics + type: object + nullable: false + allOf: + - properties: + revenue: + description: Revenue from orders + type: number + example: 1.23 + revenueTrend: + description: Revenue trend + type: number + example: 1.23 + type: object + type: object + PredefinedField: + properties: + predefinedFieldId: + type: string + readOnly: true + example: 6neM + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/predefined-fields/6neM + name: + type: string + maxLength: 32 + minLength: 1 + pattern: ^[A-Za-z0-9_]{1,32}$ + example: my_predefined_field_123 + value: + type: string + maxLength: 350 + minLength: 1 + example: my value + campaign: + type: object + $ref: '#/components/schemas/CampaignReference' + type: object + PredefinedFieldDetails: + description: The predefined field details. + type: object + readOnly: true + allOf: + - $ref: '#/components/schemas/PredefinedField' + Suppression: + required: + - suppressionId + properties: + suppressionId: + description: The suppression ID + type: string + readOnly: true + example: pypF + name: + description: The suppression name + type: string + example: suppression-name + createdOn: + description: Created on DateTime in the ISO8601 format + type: string + format: date-time + readOnly: true + example: 2018-07-26T06:33:13+0000 + href: + description: Direct hyperlink to a resource + type: string + readOnly: true + example: https://api.getresponse.com/v3/suppressions/pypF + type: object + BaseSuppression: + properties: + name: + description: The name of the suppression list + type: string + example: suppression-name + masks: + type: array + items: + type: string + example: '@example.com' + type: object + SuppressionDetails: + type: object + readOnly: true + allOf: + - $ref: '#/components/schemas/Suppression' + - $ref: '#/components/schemas/BaseSuppression' + SubscriptionConfirmationBody: + properties: + subscriptionConfirmationBodyId: + description: Subscription confirmation subject ID + type: string + example: asS1 + name: + description: Name + type: string + example: Database signup + contentPlain: + description: Plain text content equivalent of confirmation message + type: string + example: > + + Hello {{CONTACT \"subscriber_first_name\"}}, + \r\n \r\n{{INTERNAL \"body\"}}\r\n + + Your request to sign up to our\r\ndatabase has been received + and\r\nrequires your confirmation.\r\n\r\n + + EASY 1-CLICK CONFIRMATION:\r\n{{LINK \"confirm\"}}\r\n\r\nYou will + be added to the database\r\n + + instantly upon your confirmation.\r\n\r\n\r\nYou will be able to + unsubscribe\r\nor change your details at any time.\r\n\r\n + + If you have received this email in\r\nerror and did not intend to + join\r\nour database, no further action is\r\n + + required on your part.\r\n\r\nYou won't receive + further\r\ninformation and you won't be\r\n + + subscribed to any list until you\r\nconfirm your request + above.\r\n\r\n{{INTERNAL \"signature\"}} + contentHtml: + description: HTML content of confirmation message + type: string + example: '[HTML_CODE]' + type: object + SubscriptionConfirmationSubject: + properties: + subscriptionConfirmationSubjectId: + description: Subscription confirmation subject ID + type: string + example: AS3A + subject: + description: Subject + type: string + example: Action Requested - please confirm your subscription. + isPrivate: + description: Is private + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + type: object + ShopDetails: + properties: + shopId: + description: The shop ID + type: string + readOnly: true + example: pf3 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3 + name: + description: The shop name + type: string + maxLength: 124 + minLength: 4 + example: Monster market + locale: + description: The language locale (ISO 639-1) + type: string + example: PL + currency: + description: The currency code (ISO 4217) + type: string + example: PLN + productCount: + description: Amount of products in the shop + type: integer + example: '10' + productRevenue: + description: Total revenue from purchased products + type: number + example: '1.23' + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + PopupGeneralPerformanceStats: + required: + - popupId + properties: + popupId: + description: The form or popup ID + type: string + example: 7189c47e-e45f-4c45-a882-08649c48ff96 + views: + description: The total number of times your popup was viewed by website visitors + type: integer + format: int64 + example: 9 + clicks: + description: The number of clicks + type: integer + format: int64 + example: 2 + ctr: + description: >- + The number of clicks divided by the number of views, shown as a + percentage + type: integer + format: int64 + example: 5 + leads: + description: The number of leads + type: integer + format: int64 + example: 2 + type: object + PopupDetails: + properties: + popupId: + description: The form or popup ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/popups/ce84fabc-1349-4992-a2d7-0c44c5534128 + name: + description: The form or popup name + type: string + example: My popup name + status: + description: The form or popup status + type: string + enum: + - published + - unpublished + readOnly: true + type: + description: The form or popup type + type: string + enum: + - popup + - inline + readOnly: true + thumbnailUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://us-wbe-img2.gr-cdn.com/user/X/Y.webp + createdAt: + description: >- + The date the form or popup was created. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-01T10:35:00`. + type: string + format: date-time + example: '2024-01-01T10:35:00' + updatedAt: + description: >- + The date the form or popup was updated. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-10T10:00:00`. + type: string + format: date-time + example: '2024-01-10T10:00:00' + type: object + PopupListItem: + properties: + popupId: + description: The form or popup ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/popups/6b0d7d59-71d9-4708-80a6-aa0f13805111 + name: + description: The form or popup name + type: string + example: My popup name + status: + description: The form or popup status + type: string + enum: + - published + - unpublished + readOnly: true + type: + description: The form or popup type + type: string + enum: + - popup + - inline + readOnly: true + createdAt: + description: >- + The date the form or popup was created. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-01T10:35:00`. + type: string + format: date-time + updatedAt: + description: >- + The date the form or popup was updated. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-10T10:00:00`. + type: string + format: date-time + statistics: + description: The landing page statistics + $ref: '#/components/schemas/PopupListItemStatistics' + type: object + PopupListItemStatistics: + properties: + views: + description: The total number of times your popup was viewed by website visitors + type: integer + format: int64 + example: 9 + uniqueVisitors: + description: The total number of visitors + type: integer + format: int64 + example: 10 + leads: + description: The number of leads + type: integer + format: int64 + example: 5 + ctr: + description: >- + The number of clicks divided by the number of views, shown as a + percentage + type: integer + format: int64 + example: 52 + type: object + SplittestNewsletter: + properties: + newsletterId: + description: The newsletter ID + type: string + example: Z6e + href: + description: The direct newsletter URL + type: string + format: uri + example: https://api.getresponse.com/v3/newsletters/B2fvv + name: + description: The newsletter name + type: string + example: Newsletter name + subject: + description: The newsletter subject + type: string + example: Example subject + fromField: + description: The \"From\" address for the newsletter + type: object + $ref: '#/components/schemas/FromFieldReference' + status: + description: The status of the newsletter + type: string + enum: + - sampled + - chosen + - rejected + sendOn: + description: The date when the newsletter was sent + type: string + format: date-time + example: 2015-06-25T20:05:10+0000 + samplingTargets: + description: The newsletter sample targets + type: string + format: int32 + example: '2' + samplingDelivered: + description: The newsletter sample delivery + type: string + format: int32 + example: '2' + scoreOpens: + description: The newsletter open rate + type: string + format: int32 + example: '2' + scoreClicks: + description: The newsletter click rate + type: string + format: int32 + example: '2' + type: object + Splittest: + properties: + splittestId: + description: A/B test ID + type: string + example: A3r + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/splittests/A3r + name: + description: A/B test name + type: string + example: A/B test + campaign: + description: A/B test campaign + type: object + $ref: '#/components/schemas/CampaignReference' + status: + description: A/B test status + type: string + enum: + - active + - inactive + winningCriteria: + description: A/B test winning criteria + type: string + enum: + - open + - click + nullable: true + winningTarget: + description: A/B test wining target + type: string + format: int32 + example: '10' + stage: + description: A/B test stage + type: string + enum: + - queued + - schedule_sampling + - evaluate_sampling + - choose_winning + - schedule_winning + - send_winning + - canceled_queued + - canceled_sampling + - canceled_winning + - incomplete + - finished + type: + description: A/B test type + type: string + enum: + - content + - subject + - day + - hour + - from_field + samplingPercentage: + description: A/B test sample percentage + type: string + format: int32 + example: '18' + nullable: true + samplingTime: + description: A/B test sampling time in seconds + type: string + format: int32 + example: '86400' + nullable: true + chooseWinning: + description: The method of choosing the winning A/B test + type: string + enum: + - automatic + - manual + nullable: true + winningScoreOpens: + description: The open rate of the winning A/B test + type: string + format: int32 + example: '5' + winningScoreClicks: + description: The click rate of the winning A/B test + type: string + format: int32 + example: '3' + winningDelivered: + description: The delivery rate of the winning A/B test + type: string + format: int32 + example: '12' + winningScheduleOn: + description: The date for wchich the winning A/B test was scheduled + type: string + format: date-time + example: 2015-06-25T20:05:10+0000 + nullable: true + nextStepOn: + description: The date of the next step in the A/B test + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + evaluationSkippedOn: + description: The date when the A/B test was skipped + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + canceledOn: + description: The date when the A/B test was canceled + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + createdOn: + description: The date when the A/B test was created + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + newsletters: + description: The newsletters that are associated with the A/B test + type: array + items: + $ref: '#/components/schemas/SplittestNewsletter' + sendSettings: + description: The send settings for the A/B test + properties: + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSupressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + type: object + NewFile: + required: + - name + - extension + - content + - folder + properties: + content: + description: The base64 encoded file content + type: string + format: byte + example: dGVzdCBjb250ZW50 + type: object + allOf: + - $ref: '#/components/schemas/BaseFile' + BaseFile: + properties: + name: + description: The file name + type: string + maxLength: 255 + minLength: 1 + example: image + extension: + description: The file extension + type: string + example: jpg + folder: + description: The folder where the file is stored + nullable: true + allOf: + - $ref: '#/components/schemas/FolderShort' + type: object + FileGroup: + description: The file group + type: string + enum: + - audio + - video + - photo + - document + example: photo + FolderShort: + required: + - folderId + properties: + folderId: + description: The folder ID + type: string + example: 4a9f + type: object + File: + required: + - fileId + properties: + fileId: + description: The file ID + type: string + readOnly: true + example: 6rZ6 + fileSize: + description: The file size + type: integer + format: int64 + readOnly: true + example: 579644 + group: + readOnly: true + $ref: '#/components/schemas/FileGroup' + thumbnail: + description: The direct URL to the file thumbnail + type: string + format: uri + readOnly: true + example: >- + https://us-rs.gr-cdn.com/512x,sBIbGHAUIQfw7kTUjaD0fTzxfXPggsY_1WCWIKl3RAxE=/https://multimedia.getresponse.com/getresponse-ZJtEw/photos/05c53ab1-6119-4076-a96c-bbefa082ea1a.jpg + nullable: true + url: + description: The direct URL to resource + type: string + format: uri + readOnly: true + example: >- + https://multimedia.getresponse.com/getresponse-ZJtEw/photos/05c53ab1-6119-4076-a96c-bbefa082ea1a.jpg + properties: + description: The file properties (available only for the `photos` group) + type: array + items: + $ref: '#/components/schemas/FileProperty' + maxItems: 2 + minItems: 0 + readOnly: true + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + example: 2019-10-12T15:15:49+0000 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/file-library/files/6pS + type: object + allOf: + - $ref: '#/components/schemas/BaseFile' + FileProperty: + required: + - name + - value + properties: + name: + type: string + enum: + - width + - height + readOnly: true + example: width + value: + readOnly: true + oneOf: + - type: integer + example: 1980 + - type: string + type: object + Quota: + properties: + limit: + description: The total size of available storage space + type: integer + format: int64 + example: 1048576 + usage: + description: The currently used storage space + type: integer + format: int64 + example: 1024 + type: object + Folder: + required: + - folderId + properties: + folderId: + description: The folder ID + type: string + readOnly: true + example: t1G + name: + description: The folder name + type: string + maxLength: 128 + minLength: 1 + example: sample folder + size: + description: The size of all files in the directory + type: integer + format: int64 + example: 9564899 + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + example: 2019-10-14T17:17:13+0000 + type: object + NewFolder: + required: + - name + properties: + name: + description: The folder name + type: string + maxLength: 128 + minLength: 1 + example: sample folder + type: object + AbtestsSubjectDetails: + type: object + allOf: + - $ref: '#/components/schemas/AbtestsSubjectListItem' + - properties: + winnerSendingStart: + description: Date the winning message was sent on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + statistics: + description: The statistics of A/B test + properties: + total: + type: object + $ref: '#/components/schemas/AbtestsSubjectStatistics' + winner: + type: object + $ref: '#/components/schemas/AbtestsSubjectStatistics' + type: object + readOnly: true + variants: + type: array + items: + properties: + variantId: + description: >- + The message variant ID. A variant identifier from + https://apireference.getresponse.com/#operation/getAbtestsSubjectById. + type: string + readOnly: true + example: VpKJdr + subject: + description: Variant's subject + type: string + maximum: 150 + minimum: 1 + example: variant + isWinner: + description: Winning variant + type: boolean + readOnly: true + example: true + statistics: + description: Variant's statistics + type: object + readOnly: true + allOf: + - $ref: '#/components/schemas/AbtestsSubjectStatistics' + type: object + sendSettings: + description: The send settings for the A/B test + properties: + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSupressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + editor: + description: The message editor used for the A/B test + type: string + enum: + - html2 + - custom + - text + - editor_v3 + - getresponse + - legacy + nullable: true + content: + $ref: '#/components/schemas/MessageContent' + type: object + AbtestsSubjectStatistics: + properties: + delivered: + description: >- + The total number of delivered messages (winner and variants + combined) + type: integer + example: 10 + openRate: + description: The sum total of opens for the variants and the winner + type: integer + example: 8 + clickRate: + description: The message click rate + type: integer + example: 8 + type: object + AbtestsSubjectListItem: + type: object + allOf: + - $ref: '#/components/schemas/AbtestsSubject' + - properties: + status: + description: Newsletter status + type: string + enum: + - active + - inactive + - deleted + readOnly: true + stage: + description: A/B test stage + type: string + enum: + - preparing + - testing + - finished + - sending_winner + - cancelled + - draft + - completed + readOnly: true + deliverySettings: + description: The A/B test delivery settings + properties: + sendOn: + description: Date the newsletter was sent on + properties: + date: + description: Date the newsletter was sent on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + timeZone: + description: Time zone in which the newsletter was sent + properties: + timeZoneId: + description: ID of the time zone the newsletter was sent in + type: integer + timeZoneName: + description: Name of the time zone the newsletter was sent in + type: integer + nullable: true + timeZoneOffset: + description: >- + Time zone, or UTC, offset for when the newsletter + was sent + type: integer + nullable: true + type: object + type: object + winnerMode: + description: A/B test winner selection mode + type: string + enum: + - automatic + - manual + winningCriteria: + description: A/B test winning criteria + type: string + enum: + - open + - click + samplingPercentage: + description: Size of the test (sampling) group, expressed as a percentage + type: integer + format: int32 + maximum: 50 + minimum: 1 + samplingTime: + description: >- + A/B testing phase duration. The time after which the + remaining recipients will be sent the winning message + type: string + format: ISO-8601 duration + example: '86400' + nullable: true + type: object + flags: + type: array + items: + description: Tracking options enabled for the newsletter + type: string + enum: + - clicktrack + - subscription_reminder + - openrate + - google_analytics + - manual_list + - custom_footer + - ecommerce_tracking + readOnly: true + createdOn: + description: Date the A/B test was created on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + updatedOn: + description: Date A/B test was updated on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/ab-tests/subject/A3r + type: object + AbtestsSubject: + properties: + abTestId: + description: A/B test ID + type: string + readOnly: true + example: A3r + name: + description: A/B test name + type: string + maxLength: 100 + minLength: 1 + example: A/B test + campaign: + description: List linked to A/B test + properties: + campaignId: + description: Campaign ID + type: string + example: C + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/campaigns/C + name: + description: The campaign name + type: string + readOnly: true + example: Promo campaign + nullable: true + type: object + fromField: + description: Newsletter's From" address" + properties: + fromFieldId: + description: The 'From' address ID + type: string + example: V + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/V + type: object + replyTo: + description: Newsletter's reply-to address + properties: + fromFieldId: + description: The 'From' address ID + type: string + example: V + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/V + type: object + type: object + NewAbtestsSubject: + required: + - name + - href + type: object + allOf: + - required: + - name + - campaign + - fromField + properties: + abTestId: + description: A/B test ID + type: string + readOnly: true + example: A3r + name: + description: A/B test name + type: string + maxLength: 100 + minLength: 1 + example: A/B test + campaign: + description: List linked to A/B test + type: object + $ref: '#/components/schemas/CampaignReference' + fromField: + description: Newsletter's From" address" + type: object + $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: Newsletter's reply-to address + type: object + $ref: '#/components/schemas/FromFieldReference' + type: object + - required: + - deliverySettings + - variants + - sendSettings + - content + properties: + deliverySettings: + description: The A/B test delivery settings + required: + - samplingTime + - winningCriteria + - winnerMode + - sendOn + properties: + sendOn: + description: Date the newsletter was sent on + required: + - sendingType + properties: + sendingType: + description: >- + Newsletter send type. Please note that date and timezone + are not allowed with the 'now' option + type: string + enum: + - now + - scheduled + example: scheduled + date: + description: Date the newsletter was sent on + type: string + format: Y-m-d H:i:s + example: '2015-07-25T20:05:10' + nullable: true + timeZone: + description: Time zone in which the newsletter was sent + required: + - date + - timeZoneId + properties: + timeZoneId: + description: ID of the time zone the newsletter was sent in + type: integer + example: 285 + type: object + type: object + winnerMode: + description: A/B test winner selection mode + type: string + enum: + - automatic + - manual + winningCriteria: + description: A/B test winning criteria + type: string + enum: + - open + - click + samplingPercentage: + description: Size of the test (sampling) group, expressed as a percentage + type: integer + format: int32 + maximum: 50 + minimum: 1 + samplingTime: + description: >- + A/B testing phase duration. The time after which the + remaining recipients will be sent the winning message + type: string + format: ISO-8601 duration + example: P0Y0M0DT5H30M0S + nullable: true + type: object + flags: + type: array + items: + description: Tracking options enabled for the newsletter + type: string + enum: + - clicktrack + - google_analytics + - ecommerce_tracking + variants: + description: >- + Message variants. Please note, the number of subject variants + should be between 2 and 5 + required: + - subject + type: array + items: + properties: + subject: + description: Variant's subject + type: string + maximum: 150 + minimum: 1 + example: variant + type: object + sendSettings: + description: The send settings for the A/B test + properties: + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSupressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + content: + $ref: '#/components/schemas/MessageContent' + type: object + ChooseWinnerAbtestsSubject: + required: + - variantId + properties: + variantId: + description: >- + The message variant ID. A variant identifier from + https://apireference.getresponse.com/#operation/getAbtestsSubjectById. + type: string + example: VpKJdr + type: object + ClickTrackResource: + properties: + clickTrackId: + type: string + example: C12t + name: + description: The name (label) of a click track + type: string + example: Click here + url: + description: The link URL of a click track + type: string + format: uri + example: https://example.com/shop + clicks: + description: The number of clicks counted for a click track + type: integer + format: int64 + example: 25951 + message: + type: object + $ref: '#/components/schemas/ClickTrackMessage' + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/click-tracks/C12t + type: object + ClickTrackMessage: + description: The source message reference for a click track + properties: + resourceId: + description: The ID identifying message resource + type: string + example: r35N + type: + description: The message type + type: string + enum: + - broadcast + - automation + - autoresponder + - rss + - splittest + - sms + example: broadcast + createdOn: + description: The message creation date + type: string + format: date-time + example: 2019-12-01T08:21:28+0000 + resourceType: + description: Type of the resource that represents the message in the API + type: string + enum: + - newsletters + - autoresponders + - rss-newsletters + - splittests + - sms + example: newsletters + href: + description: Direct URL to the resource that represents the message + type: string + format: uri + example: https://api.getresponse.com/v3/newsletters/r35N + type: object + MessageStatisticsListElement: + properties: + timeInterval: + description: >- + The statistics time frame in the ISO 8601 datetime format with + duration interval + type: string + pattern: >- + /^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?(\/)P(?=\w*\d)(?:\d+Y|Y)?(?:\d+M|M)?(?:\d+W|W)?(?:\d+D|D)?(?:T(?:\d+H|H)?(?:\d+M|M)?(?:\d+(?:\­.\d{1,2})?S|S)?)?$/ + example: 2014-09-20T00:00:00+0000/P2M18DT10H0M0S + sent: + type: integer + format: int32 + totalOpened: + type: integer + format: int32 + uniqueOpened: + type: integer + format: int32 + totalClicked: + type: integer + format: int32 + uniqueClicked: + type: integer + format: int32 + goals: + type: integer + format: int32 + uniqueGoals: + type: integer + format: int32 + forwarded: + type: integer + format: int32 + unsubscribed: + type: integer + format: int32 + bounced: + type: integer + format: int32 + complaints: + type: integer + format: int32 + type: object + SendNewsletterDraft: + required: + - messageId + - sendSettings + properties: + messageId: + description: The message identifier (equals to newsletterId) + type: string + example: 'N' + sendOn: + description: >- + The scheduled send date for the message in the ISO 8601 format. + **Please note:** To send your message immediately, omit the `sendOn` + section + type: string + format: date-time + sendSettings: + description: How the message will be delivered to the subscriber + allOf: + - $ref: '#/components/schemas/NewsletterSendSettingsDetails' + type: object + NewsletterAttachment: + properties: + fileName: + description: The file name + type: string + example: some_file.jpg + content: + description: The base64 encoded file content + type: string + format: byte + example: sdfadsfetsdjfdskafdsaf== + mimeType: + description: The file mime type + type: string + example: image/jpeg + type: object + ExternalLexpad: + description: >- + External Lexpad settings for the message, read more: [External + Lexpad](https://apidocs.getresponse.com/v3/dynamic-content/external-lexpad) + required: + - dataSourceUrl + properties: + dataSourceUrl: + description: URL to the endpoint that will provide data for External Lexpad + type: string + format: uri + maxLength: 2048 + minLength: 1 + example: https://example.com/external_lexpad + dataSourceToken: + description: >- + Token that will be sent in `X-Auth-Token` header to authenticate the + requests made to the endpoint + type: string + maxLength: 255 + minLength: 0 + example: cf4dfca78434bf927a7655c0c4d95a2a45c33b71 + nullable: true + type: object + NewsletterSendSettingsDetails: + properties: + selectedCampaigns: + description: The list of selected campaigns + items: + type: string + example: V + selectedSegments: + description: The list of selected segments + items: + type: string + example: S + selectedSuppressions: + description: The list of selected suppressions (suppressions exclude contacts) + items: + type: string + example: Se + excludedCampaigns: + description: The list of excluded campaigns + items: + type: string + example: O + excludedSegments: + description: The list of excluded segments + items: + type: string + example: R + selectedContacts: + description: The list of selected contacts + items: + type: string + example: Qs + timeTravel: + description: >- + Use the time travel functionality. This means that the system will + match the scheduled sending hour for the message to the time zone of + each recipient. As a result, sending may take up to 24 hours. + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + perfectTiming: + description: Use the perfect timing functionality + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + externalLexpad: + description: >- + External Lexpad settings for the message, read more: [External + Lexpad](https://apidocs.getresponse.com/v3/dynamic-content/external-lexpad) + nullable: true + allOf: + - $ref: '#/components/schemas/ExternalLexpad' + type: object + Newsletter: + required: + - newsletterId + - href + properties: + newsletterId: + description: The newsletter ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/newsletters/N + name: + description: The newsletter name + type: string + maxLength: 128 + minLength: 2 + example: New message + type: + description: The newsletter type + type: string + default: broadcast + enum: + - broadcast + - draft + status: + description: The newsletter status + readOnly: true + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + editor: + description: This describes how the content of the message was created + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + subject: + description: The message subject + type: string + maxLength: 128 + minLength: 2 + example: Annual report + fromField: + description: The 'From' email address used for the message + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The email that will be used as the reply-to address + allOf: + - $ref: '#/components/schemas/FromFieldReference' + campaign: + description: The newsletter must be assigned to a campaign + allOf: + - $ref: '#/components/schemas/CampaignReference' + sendOn: + description: >- + The scheduled send date and time for the newsletter in the ISO 8601 + format. + type: string + format: date-time + readOnly: true + attachments: + description: >- + The newsletter attachments. The size of all attachments combined + can't exceed 400KB + type: array + items: + $ref: '#/components/schemas/NewsletterAttachment' + sendSettings: + description: >- + How the message will be delivered to the subscriber. You can specify + multiple parameters. Then the system uses AND logic. + allOf: + - $ref: '#/components/schemas/NewsletterSendSettingsDetails' + sendMetrics: + description: The sending metrics + type: object + readOnly: true + allOf: + - properties: + status: + type: string + default: finished + enum: + - scheduled + - in_progress + - finished + sent: + description: Messages already sent + type: string + default: '0' + total: + description: The total amount of messages to send + type: string + default: '0' + type: object + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + NewNewsletter: + required: + - subject + - fromField + - campaign + - content + - sendSettings + properties: + content: + $ref: '#/components/schemas/MessageContent' + flags: + $ref: '#/components/schemas/MessageFlagsArray' + name: + description: The newsletter name + type: string + maxLength: 128 + minLength: 2 + example: New message + type: + description: The newsletter type + type: string + default: broadcast + enum: + - broadcast + - draft + editor: + description: This describes how the content of the message was created + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + subject: + description: The message subject + type: string + maxLength: 128 + minLength: 2 + example: Annual report + fromField: + description: The 'From' email address used for the message + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The email that will be used as the reply-to address + allOf: + - $ref: '#/components/schemas/FromFieldReference' + campaign: + description: The newsletter must be assigned to a campaign + allOf: + - $ref: '#/components/schemas/CampaignReference' + sendOn: + description: >- + The scheduled send date and time for the newsletter in the ISO 8601 + format. **Please note:** To send your message immediately, omit the + `sendOn` section + type: string + format: date-time + attachments: + description: >- + The newsletter attachments. The size of all attachments combined + can't exceed 400KB + type: array + items: + $ref: '#/components/schemas/NewsletterAttachment' + sendSettings: + description: >- + How the message will be delivered to the subscriber. You can specify + multiple parameters. Then the system uses AND logic. + allOf: + - $ref: '#/components/schemas/NewsletterSendSettingsDetails' + type: object + NewsletterDetails: + properties: + content: + $ref: '#/components/schemas/MessageContent' + clickTracks: + description: The list of tracked links + type: array + items: + $ref: '#/components/schemas/ClickTrack' + flags: + $ref: '#/components/schemas/MessageFlagsArray' + type: object + allOf: + - $ref: '#/components/schemas/Newsletter' + NewsletterListElement: + required: + - newsletterId + - href + properties: + newsletterId: + description: The newsletter ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/newsletters/N + name: + description: The newsletter name + type: string + maxLength: 128 + minLength: 2 + example: New message + type: + description: The newsletter type + type: string + default: broadcast + enum: + - broadcast + - draft + status: + description: The newsletter status + readOnly: true + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + editor: + description: This describes how the content of the message was created + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + subject: + description: The message subject + type: string + maxLength: 128 + minLength: 2 + example: Annual report + campaign: + description: The newsletter must be assigned to a campaign + allOf: + - $ref: '#/components/schemas/CampaignReference' + sendOn: + description: >- + The scheduled send date and time for the newsletter in the ISO 8601 + format. + type: string + format: date-time + sendSettings: + description: >- + How the message will be delivered to the subscriber. You can specify + multiple parameters. Then the system uses AND logic. + allOf: + - $ref: '#/components/schemas/NewsletterSendSettingsListing' + sendMetrics: + description: The sending metrics + type: object + readOnly: true + allOf: + - properties: + status: + type: string + default: finished + enum: + - scheduled + - in_progress + - finished + sent: + description: Messages already sent + type: string + default: '0' + total: + description: The total amount of messages to send + type: string + default: '0' + type: object + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + flags: + $ref: '#/components/schemas/MessageFlagsString' + type: object + NewsletterSendSettingsListing: + properties: + timeTravel: + description: >- + Use the time travel functionality. This means that the system will + match the scheduled sending hour for the message to the time zone of + each recipient. As a result, sending may take up to 24 hours. + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + perfectTiming: + description: Use the perfect timing functionality + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + type: object + ClickTrack: + properties: + clickTrackId: + type: string + example: C + url: + description: The tracked link + type: string + format: uri + example: https://example.com + name: + description: The tracked link name + type: string + example: press here + amount: + description: The number of clicks on a link in a message + type: string + example: '15' + type: object + NewsletterActivity: + properties: + activity: + description: The type of activity + type: string + enum: + - send + - open + - click + createdOn: + description: The date when activity occurred + type: string + format: date-time + example: 2019-10-21T11:08:45+0000 + contact: + description: The contact ID + allOf: + - $ref: '#/components/schemas/NewsletterActivityContactReference' + type: object + NewsletterActivityContactReference: + properties: + contactId: + description: The contact ID + type: string + example: pV3r + email: + description: The contact email + type: string + example: contact@domain.com + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/contacts/pV3r + type: object + NewTag: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseTag' + UpdateTag: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseTag' + TagDetails: + properties: + tagId: + description: The tag ID. + type: string + readOnly: true + createdAt: + type: string + format: date-time + readOnly: true + example: 2018-07-20T06:24:14+0000 + type: object + allOf: + - $ref: '#/components/schemas/BaseTag' + Tag: + required: + - tagId + - name + - href + - color + - createdAt + properties: + tagId: + description: The tag ID + type: string + readOnly: true + example: vBd5 + href: + description: The direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/tags/vBd5 + createdAt: + type: string + format: date-time + readOnly: true + example: 2020-11-20T08:00:00+0000 + type: object + allOf: + - $ref: '#/components/schemas/BaseTag' + BaseTag: + properties: + name: + description: The tag name + type: string + maxLength: 255 + minLength: 2 + pattern: ^[_a-zA-Z0-9]{2,255}$ + example: My_Tag + color: + description: The tag color (deprecated) + type: string + readOnly: true + deprecated: true + type: object + Blocklist: + properties: + masks: + type: array + items: + type: string + example: jack@somedomain.com + type: object + UpdateBlocklist: + required: + - masks + type: object + allOf: + - $ref: '#/components/schemas/Blocklist' + CustomFieldReference: + required: + - customField + properties: + customFieldId: + type: string + readOnly: true + example: pas + name: + description: >- + + The name of the custom field. It must meet the following + requirements: + * be unique + * use only lowercase letters, underscores and digits: [a-z0-9_]{1,128} + * not be equal to one of the merge words used in messages, i.e. `name`, `email`, `twitter`, `facebook`, `buzz`, `myspace`, `linkedin`, `digg`, `googleplus`, `pinterest`, `responder`, `campaign`, `change`. + type: string + maxLength: 128 + minLength: 1 + example: color + values: + description: >- + The list of assigned default values, starting from zero depending on + the custom field type. (Please see description). + type: array + items: + type: string + example: red + type: object + Lps: + type: object + allOf: + - $ref: '#/components/schemas/LpsListItem' + - properties: + statistics: + description: The landing page statistics + $ref: '#/components/schemas/LpsListItemStatistics' + type: object + LpsListItem: + properties: + lpsId: + description: The landing page ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/lps/6b0d7d59-71d9-4708-80a6-aa0f13805111 + name: + description: The landing page name + type: string + example: 'Predesigned #017' + status: + description: The landing page status + type: string + enum: + - published + - unpublished + readOnly: true + domainUrl: + description: The landing page domain + type: string + format: uri + readOnly: true + example: predesigned-017-52612.grweb.site + thumbnailUrl: + description: The URL of a landing page thumbnail + type: string + format: uri + readOnly: true + example: >- + https://us-wbe-img2.gr-cdn.com/user/e5c2094a-2354-459f-9b9f-6d0369ccae2c/6b0d7d59-71d9-4708-80a6-aa0f13805111.png?width=208 + isChatsEnabled: + description: Chats is enabled on the landing page + example: true + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + createdAt: + description: The date the landing page was created + type: string + format: date-time + updatedAt: + description: The date the landing page was updated + type: string + format: date-time + type: object + LpsListItemStatistics: + properties: + visits: + description: The number of browsing sessions initiated on your landing page + type: integer + format: int64 + example: 9 + leads: + description: Number of leads + type: integer + format: int64 + example: 5 + subscriptionRate: + description: >- + The number of leads divided by the number of visitors, shown as a + percentage + type: integer + format: int64 + example: 52 + type: object + LpsDetails: + type: object + allOf: + - $ref: '#/components/schemas/LpsListItem' + - $ref: '#/components/schemas/LpsDetailsStatistics' + - properties: + pages: + type: array + items: + $ref: '#/components/schemas/LpsPage' + type: object + LpsDetailsStatistics: + properties: + pageViews: + description: The total number of times your landing page was viewed or refreshed + type: integer + format: int64 + example: 9 + visits: + description: The number of browsing sessions initiated on your landing page + type: integer + format: int64 + example: 5 + uniqueVisitors: + description: The number of people who visited your landing page + type: integer + format: int64 + example: 5 + type: object + LpsPage: + properties: + uuid: + description: >- + The ID of a page associated with the landing page (i.e., 404 page + and thank you page) + type: string + readOnly: true + example: 6ee7597f-9bde-4b92-9411-2fb228c9fa34 + name: + description: >- + The name of a page associated with the landing page (i.e., 404 page + and thank you page) + type: string + example: Home + status: + description: >- + The status of a page associated with the landing page (i.e., 404 + page or thank you page) + type: string + enum: + - active + - inactive + url: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: /terms-of-service + redirectUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: '' + createdAt: + description: >- + The date a page associated with the landing page (i.e., 404 page or + thank you page) was created + type: string + format: date-time + type: object + LpsStats: + required: + - lpsId + properties: + lpsId: + description: The landing page ID + type: string + example: 6ee7597f-9bde-4b92-9411-2fb228c9fa34 + name: + type: string + example: Some example landing page + pageViews: + description: The total number of times your landing page was viewed or refreshed + type: integer + format: int64 + example: 9 + visits: + description: The number of browsing sessions initiated on your landing page + type: integer + format: int64 + example: 5 + uniqueVisitors: + description: The number of people who visited your landing page + type: integer + format: int64 + example: 5 + thumbnailUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://us-wbe-img2.gr-cdn.com/user/X/Y.webp + type: object + ImageDetails: + properties: + imageId: + description: Image ID + type: string + example: '123456' + originalImageUrl: + description: URL from which image was downloaded + type: string + format: uri + example: http://somesite.example.com/my_image.jpg + nullable: true + size: + description: Size in bytes + type: string + example: '1234567' + name: + description: Original name + type: string + example: original_image + thumbnailUrl: + description: Thumbnail URL + type: string + format: uri + example: >- + https://us-re.gr-cdn.com/114x/https://multimedia.getresponse.com/getresponse-hUXzv/photos/123456.jpg + url: + description: Asset URL + type: string + format: uri + example: >- + https://multimedia.getresponse.com/getresponse-hUXzv/photos/123456.jpg + extension: + description: File extension + type: string + enum: + - jpg + - gif + - png + - jpeg + - bmp + example: jpg + type: object + CreateMultimedia: + properties: + file: + type: string + format: binary + type: object + Tracking: + properties: + grid: + type: string + readOnly: true + example: 2fEBK5kj4ReCxUvd + snippet: + type: string + readOnly: true + example: >- + + snippetV2: + type: string + readOnly: true + example: + type: object + FacebookPixel: + properties: + name: + type: string + readOnly: true + example: integration-pixel + pixelId: + type: string + readOnly: true + example: '123' + type: object + StatusEnum: + type: string + enum: + - enabled + - disabled + StringBooleanEnum: + type: string + enum: + - 'true' + - 'false' + SortOrderEnum: + type: string + enum: + - ASC + - DESC + DateOrDateTime: + oneOf: + - type: string + format: date + example: '2018-04-15' + - type: string + format: date-time + example: 2018-01-15T13:30:42+0000 + ErrorResponse: + required: + - httpStatus + - code + - codeDescription + - message + - moreInfo + - context + - uuid + properties: + httpStatus: + description: HTTP response code + type: integer + format: int32 + code: + description: API error code + type: integer + format: int32 + codeDescription: + description: API error code description + type: string + message: + description: Error message + type: string + moreInfo: + description: URL to error description in the API Docs + type: string + context: + type: array + items: + type: string + uuid: + description: UUID of the error response + type: string + type: object + AccountBadgeDetails: + properties: + status: + description: Current badge status + example: enabled + $ref: '#/components/schemas/StatusEnum' + type: object + UpdateAccountBadge: + required: + - status + type: object + allOf: + - $ref: '#/components/schemas/AccountBadgeDetails' + SendingLimitsListItem: + properties: + timeFrame: + description: Time frame, measured in seconds + type: integer + example: 2592000 + limit: + description: The number of email sends available within a given time frame + type: integer + example: 2500 + used: + description: The number of email sends used within the given time frame + type: integer + example: 0 + type: object + IndustryTagId: + properties: + industryTagId: + description: Industry tag ID + type: string + format: integer + example: '1' + type: object + IndustryTagProperties: + properties: + name: + type: string + readOnly: true + example: Marketing agencies + description: + type: string + readOnly: true + example: Marketing agencies big and small, with fluent and wise agents... + type: object + IndustryTag: + required: + - industryTagId + type: object + allOf: + - $ref: '#/components/schemas/IndustryTagId' + - $ref: '#/components/schemas/IndustryTagProperties' + TimezoneName: + properties: + name: + description: >- + Time zone name as defined by + https://en.wikipedia.org/wiki/List_of_tz_database_time_zones + type: string + example: Europe/Warsaw + type: object + TimezoneOffset: + properties: + offset: + type: string + pattern: /^(?:Z|[+-](?:2[0-3]|[01][0-9]):[0-5][0-9])$/ + example: '+01:00' + type: object + TimezoneId: + properties: + timezoneId: + type: integer + format: int32 + example: 1 + type: object + TimezoneCountry: + properties: + country: + type: string + example: Poland + type: object + Timezone: + required: + - timezoneId + allOf: + - $ref: '#/components/schemas/TimezoneId' + - $ref: '#/components/schemas/TimezoneName' + - $ref: '#/components/schemas/TimezoneOffset' + - $ref: '#/components/schemas/TimezoneCountry' + AccountsLoginHistoryListElement: + properties: + loginTime: + description: Login time + type: string + format: date-time + example: 2004-02-12T15:19:21+0000 + logoutTime: + description: Logout time + type: string + format: date-time + example: 2004-02-12T15:19:21+0000 + nullable: true + isSuccessful: + description: Login was successful + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + ip: + description: IP address + type: string + format: ipv4 + example: 192.0.0.1 + type: object + CallbackActions: + properties: + open: + description: Is `open` callback enabled + type: boolean + click: + description: Is `click` callback enabled + type: boolean + goal: + description: Is `goal` callback enabled + type: boolean + subscribe: + description: Is `subscribe` callback enabled + type: boolean + unsubscribe: + description: Is `unsubscribe` callback enabled + type: boolean + survey: + description: Is `survey` callback enabled + type: boolean + type: object + Callback: + properties: + url: + description: URL to use to post notifications + format: uri + actions: + $ref: '#/components/schemas/CallbackActions' + type: object + AccountDetailsCountryCode: + properties: + countryCodeId: + description: Country code ID + type: string + example: '175' + countryCode: + description: Country code + type: string + example: PL + type: object + AccountBilling: + properties: + listSize: + description: Billing plan maximum list size + type: string + example: '2500' + paymentPlan: + description: Payment plan + type: string + enum: + - Free Trial + - Monthly + - 12 Months + - 24 Months + example: Monthly + subscriptionPrice: + description: Subscription price + type: integer + example: 25 + renewalDate: + description: Subscription reneval date + type: string + format: date + example: '2017-01-01' + currencyCode: + description: Currency code compliant with ISO-4217 + type: string + example: USD + accountBalance: + description: Account balance + type: string + example: '-15.00' + price: + description: Price + type: integer + example: 25 + paymentMethod: + description: Payment method + type: string + enum: + - outside_system + - inside_system + - credit_card + - platnosci_pl + - direct_debit + - paypal + - yandex + - alipay + - alipay_mobile + - boleto + - ideal + - qiwi + - sofort + - webmoney + example: credit_card + creditCard: + type: object + nullable: true + allOf: + - properties: + number: + description: Masked credit card number + type: string + example: XXXXXXXXX0123 + type: object + - properties: + expirationDate: + description: Expiration date + type: string + format: date + example: '2014-01-01' + type: object + addons: + description: Addons + type: array + items: + properties: + name: + description: Addon name + type: string + example: Landing Page Creator + price: + description: Addon price + type: integer + example: 15 + active: + description: Addon active status + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + type: object + type: object + SubscriptionsByDatesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignSubscriptionStatisticsList' + CampaignSubscriptionStatisticsList: + description: Dates in the YYYY-MM-DD format are used as keys. + type: object + example: + '2014-12-15': + V: + import: 10 + email: 11 + www: 10 + panel: 14 + leads: 3 + sale: 3 + api: 1 + forward: 15 + survey: 6 + mobile: 12 + copy: 7 + landing_page: 4 + summary: 99 + p: + import: 9 + email: 7 + www: 9 + panel: 5 + leads: 3 + sale: 3 + api: 8 + forward: 10 + survey: 8 + mobile: 10 + copy: 10 + landing_page: 7 + summary: 93 + additionalProperties: + description: Dates in YYYY-MM-DD format are used as keys + type: object + allOf: + - $ref: '#/components/schemas/CampaignSubscriptionStatisticsItemByCampaign' + CampaignRemovalsStatisticsItem: + type: object + anyOf: + - properties: + api: + type: integer + example: 1 + type: object + - properties: + automation: + type: integer + example: 1 + type: object + - properties: + blacklisted: + type: integer + example: 1 + type: object + - properties: + bounce: + type: integer + example: 1 + type: object + - properties: + cleaner: + type: integer + example: 1 + type: object + - properties: + compliant: + type: integer + example: 1 + type: object + - properties: + support: + type: integer + example: 1 + type: object + - properties: + unsubscribe: + type: integer + example: 1 + type: object + - properties: + user: + type: integer + example: 1 + type: object + CampaignSubscriptionStatisticsItemByCampaign: + description: The properties of the result are indexed with the campaign ID. + type: object + example: + V: + import: 10 + email: 11 + www: 10 + panel: 14 + leads: 3 + sale: 3 + api: 1 + forward: 15 + survey: 6 + mobile: 12 + copy: 7 + landing_page: 4 + webinar: 3 + summary: 99 + p: + import: 9 + email: 7 + www: 9 + panel: 5 + leads: 3 + sale: 3 + api: 8 + forward: 10 + survey: 8 + mobile: 10 + copy: 10 + landing_page: 7 + webinar: 4 + summary: 93 + additionalProperties: + description: The properties of the result are indexed with the campaign ID + $ref: '#/components/schemas/CampaignSubscriptionStatisticsItem' + CampaignSubscriptionStatisticsItem: + properties: + import: + type: integer + example: 0 + email: + type: integer + example: 0 + www: + type: integer + example: 0 + panel: + type: integer + example: 0 + leads: + type: integer + example: 0 + sale: + type: integer + example: 0 + api: + type: integer + example: 0 + forward: + type: integer + example: 0 + survey: + type: integer + example: 0 + mobile: + type: integer + example: 0 + copy: + type: integer + example: 0 + landing_page: + type: integer + example: 0 + webinar: + type: integer + example: 0 + summary: + type: integer + example: 0 + type: object + CampaignSummaryList: + type: array + items: + $ref: '#/components/schemas/CampaignSummaryItem' + CampaignLocationsList: + type: array + items: + $ref: '#/components/schemas/CampaignLocationItem' + RemovalsByDatesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignRemovalsStatisticsList' + CampaignRemovalsStatisticsList: + type: object + example: + '2014-12-05': + user: 5 + '2015-01-22': + user: 12 + bounce: 2 + additionalProperties: + description: Dates in YYYY-MM-DD format are used as keys + $ref: '#/components/schemas/CampaignRemovalsStatisticsItem' + CampaignLocationItem: + type: object + example: + others: + amount: '6' + continentCode: '' + countryCode: '' + PL: + amount: '45' + continentCode: EU + countryCode: PL + additionalProperties: + description: The results are indexed with the location name (PL, EN, etc.) + properties: + amount: + description: The amount of subscribers from a given location + type: string + format: number + example: '0' + continentalCode: + description: The region code + type: string + example: EU + countryCode: + description: The country code + type: string + example: PL + type: object + CampaignOriginsList: + type: array + items: + $ref: '#/components/schemas/CampaignSubscriptionStatisticsItemByCampaign' + CampaignListSizesStatisticsElement: + properties: + totalSubscribers: + description: The total amount of subscribers for a given datetime and grouping + type: integer + format: int64 + addedSubscribers: + description: The amount of subscribers added since the previous statistics frame + type: integer + format: int64 + removedSubscribers: + description: >- + The amount of subscribers removed since the previous statistics + frame + type: integer + format: int64 + createdOn: + description: >- + The statistics frame timestamp. The value depends on the groupBy + parameter. For the hour, use datetime in the format YYYY-mm-dd + HH:mm:ss; for the day, use date in the format YYYY-mm-dd; for the + month, use a string in the format YYYY-mm; and for the total, use + the string total. + type: string + type: object + CampaignListSizesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignListSizesStatisticsElement' + BalanceByDatesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignBalanceStatisticsList' + CampaignBalanceStatisticsList: + type: object + example: + '2014-12-05': + removals: + user: 5 + subscriptions: + import: 0 + email: 0 + www: 0 + panel: 0 + leads: 0 + sale: 0 + api: 7 + forward: 0 + survey: 0 + mobile: 0 + copy: 0 + landing_page: 0 + summary: 7 + '2015-01-21': + removals: + user: 10 + additionalProperties: + description: Dates in YYYY-MM-DD format are used as keys + anyOf: + - properties: + removals: + type: object + allOf: + - $ref: '#/components/schemas/CampaignRemovalsStatisticsItem' + type: object + - properties: + subscriptions: + type: object + allOf: + - $ref: '#/components/schemas/CampaignSubscriptionStatisticsItem' + type: object + CampaignSummaryItem: + description: >- + The properties of the result are indexed with the location name (PL, EN, + etc.). + type: object + example: + o5lx: + totalSubscribers: '4' + totalNewsletters: '129' + totalTriggers: '0' + totalLandingPages: '1' + totalWebforms: '3' + CC9F: + totalSubscribers: '0' + totalNewsletters: '0' + totalTriggers: '0' + totalLandingPages: '5' + totalWebforms: '0' + V6OeR: + totalSubscribers: '0' + totalNewsletters: '0' + totalTriggers: '0' + totalLandingPages: '0' + totalWebforms: '0' + additionalProperties: + properties: + totalSubscribers: + description: The total number of subscribers + type: string + format: number + example: '0' + totalNewsletters: + description: The total number of newsletters + type: string + format: number + example: '0' + totalTriggers: + description: The total number of triggers + type: string + format: number + example: '0' + totalLandingPages: + description: The total number of landing pages + type: string + format: number + example: '0' + totalWebforms: + description: The total number of webforms + type: string + format: number + example: '0' + type: object + CampaignListElement: + properties: + description: + description: It's the same as the campaign name, kept for compatibility reasons + type: string + readOnly: true + example: my_campaign + type: object + allOf: + - $ref: '#/components/schemas/BaseCampaign' + CampaignReference: + required: + - campaignId + properties: + campaignId: + description: Campaign ID + type: string + example: C + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/campaigns/C + name: + description: The campaign name + type: string + readOnly: true + example: Promo campaign + nullable: true + type: object + CampaignStatisticsIdQuery: + type: string + example: 3Va2e + LegacyForm: + properties: + webformId: + description: The webform (Legacy Form) ID + type: string + example: NPKx + name: + type: string + example: Webform 2010/7/5 + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/webforms/NPKx + scriptUrl: + description: The URL of the script that displays the Legacy Form + type: string + format: uri + example: https://app.getresponse.com/view_webform.js?u=VfEy1&wid=11774901 + status: + $ref: '#/components/schemas/StatusEnum' + modifiedOn: + description: The modification date + type: string + format: date-time + statistics: + $ref: '#/components/schemas/LegacyFormStatistics' + campaign: + $ref: '#/components/schemas/CampaignReference' + type: object + LegacyFormStatistics: + properties: + opened: + description: The number of Legacy Form views + type: integer + format: int64 + example: 1234 + subscribed: + description: The number of contacts that subscribed using this Legacy Form + type: integer + format: int64 + example: 100 + type: object + GDPRField: + properties: + gdprFieldId: + type: string + readOnly: true + example: MtY + name: + description: The name of the GDPR field + type: string + example: 'Consent #1' + createdOn: + type: string + format: date-time + example: 2018-08-01T09:18:00+0000 + href: + description: The direct hyperlink to the resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/gdpr-fields/MtY + type: object + GDPRFieldLatestVersion: + properties: + gdprFieldVersionId: + type: string + readOnly: true + example: yRI + content: + description: The content of the GDPR field + type: string + readOnly: true + example: '1st version of Consent #1' + createdOn: + type: string + format: date-time + example: 2018-08-02T11:12:00+0000 + type: object + GDPRFieldDetails: + type: object + allOf: + - $ref: '#/components/schemas/GDPRField' + - properties: + latestVersion: + $ref: '#/components/schemas/GDPRFieldLatestVersion' + type: object + UpdateWorkflow: + required: + - status + properties: + status: + description: >- + An 'incomplete' status means that the workflow is a 'draft' in the + web panel + type: string + enum: + - active + - inactive + - incomplete + example: active + type: object + Workflow: + required: + - workflowId + - name + - status + - subscriberStatistics + properties: + workflowId: + description: The workflow ID + type: string + readOnly: true + example: pxs + name: + type: string + example: My draft + status: + type: string + enum: + - active + - inactive + - incomplete + example: active + dateStart: + type: string + format: date-time + example: 2014-02-12T15:19:21+0000 + dateStop: + type: string + format: date-time + example: 2014-04-12T15:19:21+0000 + subscriberStatistics: + $ref: '#/components/schemas/WorkflowSubscriberStatistics' + type: object + WorkflowSubscriberStatistics: + required: + - completedCount + - inProgressCount + properties: + completedCount: + description: The number of subscribers that completed the workflow + type: integer + format: int64 + readOnly: true + example: 4 + inProgressCount: + description: The number of subscribers that are in progress in the workflow + type: integer + format: int64 + readOnly: true + example: 3 + type: object + SmsDetails: + properties: + sendSettings: + description: How the message will be delivered to the subscriber + type: object + nullable: true + allOf: + - properties: + contacts: + description: >- + The details of recipients who are in your contact list + (recipientsType = \"contacts\"). If the recipient is not in + your GetResponse contacts, the property is null. + nullable: true + allOf: + - properties: + selectedCampaigns: + $ref: >- + #/components/schemas/MessageSendSettingSelectedCampaigns + selectedSegments: + $ref: >- + #/components/schemas/MessageSendSettingSelectedSegments + excludedCampaigns: + $ref: >- + #/components/schemas/MessageSendSettingExcludedCampaigns + excludedSegments: + $ref: >- + #/components/schemas/MessageSendSettingExcludedSegments + selectedContacts: + description: The list of contact IDs. + items: + type: string + example: V2 + type: object + importedNumbers: + description: >- + The details of recipients whose numbers are imported + (recipientsType = \"importedNumbers\"). If the recipient is + in your GetResponse contacts, the property is null. + nullable: true + allOf: + - properties: + count: + description: Number of phone numbers entered manually + type: integer + example: 10 + type: object + type: object + clickTracks: + description: >- + Details of links attached to SMS message. Maximum 20 links will be + returned. + type: array + items: + allOf: + - properties: + clickTrackId: + description: The click track ID + type: string + example: a2 + href: + description: Direct hyperlink to a resource + type: string + example: https://api.getresponse.com/v3/click-tracks/a2 + url: + description: The link URL + type: string + example: https://example.com + label: + description: The link label + type: string + example: example-link + amount: + description: Number of clicks on a link + type: integer + example: 2 + uniqueAmount: + description: Number of unique clicks on link + type: integer + example: 1 + type: object + type: object + allOf: + - $ref: '#/components/schemas/SmsListItem' + SmsAutomationListItem: + required: + - smsId + properties: + smsId: + description: The automated SMS message ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/sms-automation/N + name: + description: The automated SMS message name + type: string + maxLength: 128 + minLength: 2 + example: New message + campaign: + description: The campaign the SMS message is in + allOf: + - $ref: '#/components/schemas/CampaignReference' + modifiedOn: + description: >- + The date the automated SMS message was last modified on, shown in + `ISO 8601` date and time format. e.g. `2022-04-10T10:02:57+0000` + type: string + format: date-time + status: + description: The status of of the automated SMS message + type: string + enum: + - ready + - in_use + statistics: + description: Automate SMS message statistics + allOf: + - properties: + sent: + description: The number od sent automated SMS messages + type: integer + example: 12 + delivered: + description: The number of delivered automated SMS messages + type: integer + example: 10 + clicks: + description: The number of automated SMS link clicks + type: integer + example: 8 + type: object + senderName: + description: The name of the sender of the automated SMS message + type: string + readOnly: true + hasLinks: + description: Information is the automated SMS message contains links + type: boolean + readOnly: true + type: object + SmsListItem: + required: + - newsletterId + - href + properties: + smsId: + description: The SMS message ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/sms/N + name: + description: The SMS message name + type: string + maxLength: 128 + minLength: 2 + example: New message + campaign: + description: The SMS message campaign + allOf: + - $ref: '#/components/schemas/CampaignReference' + modifiedOn: + description: >- + The date the SMS message was last modified on, shown in `ISO 8601` + date and time format. e.g. `2022-04-10T10:02:57+0000` + type: string + format: date-time + type: + description: The SMS message type + type: string + enum: + - sms + - draft + readOnly: true + sendOn: + description: SMS message send date details + type: object + nullable: true + allOf: + - properties: + date: + description: >- + Send date. Shown in format `ISO 8601` without timezone + offset e.g. `2022-04-10T10:02:57`. + type: string + format: date-time + example: '2022-03-26T10:35:00' + timeZone: + description: Time zone details + type: object + allOf: + - properties: + timeZoneId: + description: Time zone ID + type: integer + example: '123' + timeZoneName: + description: Time zone name + type: string + example: America/New_York + timeZoneOffset: + description: Time zone offset + type: string + example: '-05:00' + type: object + type: object + recipientsType: + description: Type of SMS message recipients + type: string + enum: + - contacts + - importedNumbers + readOnly: true + example: contacts + senderName: + description: The SMS message sender name + type: string + readOnly: true + content: + description: The SMS message content + type: string + example: This is my SMS content + sendMetrics: + description: Information about sending process + type: object + allOf: + - properties: + progress: + description: Sending progress + type: string + status: + description: Sending status + type: string + enum: + - scheduled + - sending + - sent + type: object + statistics: + description: Message statistics + allOf: + - properties: + sent: + description: Number of sent messages + type: integer + example: 12 + delivered: + description: Number of delivered messages + type: integer + example: 10 + clicks: + description: Number of clicked messages + type: integer + example: 8 + type: object + type: object + AutoresponderDetails: + properties: + clickTracks: + description: The list of tracked links + type: array + items: + $ref: '#/components/schemas/ClickTrack' + campaign: + description: The autoresponder campaign (list) + allOf: + - $ref: '#/components/schemas/CampaignReference' + type: object + allOf: + - $ref: '#/components/schemas/Autoresponder' + AutoresponderList: + type: array + items: + properties: + campaign: + description: The autoresponder campaign (list) + allOf: + - $ref: '#/components/schemas/CampaignReference' + type: object + allOf: + - $ref: '#/components/schemas/Autoresponder' + Website: + properties: + websiteId: + description: The website ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/websites/6b0d7d59-71d9-4708-80a6-aa0f13805111 + name: + description: The website name + type: string + example: 'Predesigned #017' + status: + description: The website status + type: string + enum: + - published + - unpublished + readOnly: true + domainUrl: + description: The website domain + type: string + format: uri + readOnly: true + example: predesigned-017-52612.grweb.site + thumbnailUrl: + description: The URL of a website thumbnail + type: string + format: uri + readOnly: true + example: >- + https://us-wbe-img2.gr-cdn.com/user/e5c2094a-2354-459f-9b9f-6d0369ccae2c/6b0d7d59-71d9-4708-80a6-aa0f13805111.png?width=208 + isChatsEnabled: + description: Chats is enabled on the website + example: true + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + createdAt: + description: The date the website was created + type: string + format: date-time + updatedAt: + description: The date the website was updated + type: string + format: date-time + statistics: + description: The website statistics + $ref: '#/components/schemas/WebsiteStatistics' + type: object + WebsiteStatistics: + properties: + pageViews: + description: Number of page views + type: integer + format: int64 + example: 9 + visits: + description: Number of site visits + type: integer + format: int64 + example: 5 + uniqueVisitors: + description: Number of unique visitors + type: integer + format: int64 + example: 5 + type: object + WebsiteStats: + required: + - websiteId + properties: + websiteId: + description: The website ID + type: string + example: PvLI8C + name: + type: string + example: Variant A + pageViews: + description: The number of page views + type: integer + example: 1 + visits: + description: The number of visits + type: integer + example: 1 + uniqueVisitors: + description: The number of unique visitors + type: integer + example: 1 + thumbnailUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/wbe/N + type: object + WebsiteDetails: + type: object + allOf: + - $ref: '#/components/schemas/Website' + - properties: + pages: + type: array + items: + $ref: '#/components/schemas/WebsitePage' + type: object + WebsitePage: + properties: + uuid: + description: The website page ID + type: string + readOnly: true + example: 6ee7597f-9bde-4b92-9411-2fb228c9fa34 + name: + description: The website page name + type: string + example: Home + status: + description: The website page status + type: string + enum: + - active + - inactive + url: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: /terms-of-service + redirectUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: '' + createdAt: + description: The date the website page was created + type: string + format: date-time + type: object + responses: + WebinarDetails: + description: The webinar details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Webinar' + WebinarList: + description: The list of webinars + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Webinar' + UpsertContactTags: + description: ' The list of contact tags.' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactTag' + ContactActivityList: + description: The list of contact activities. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactActivity' + ContactCustomFieldList: + description: The list of custom fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactCustomFieldList' + ContactList: + description: The list of contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactListElement' + ContactDetails: + description: The contact details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactDetails' + BaseSearchContactsList: + description: The saved search contact. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BaseSearchContactsDetails' + SearchContactsDetails: + description: Search contact details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SearchContactsDetails' + SearchedContactsList: + description: The contact list. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SearchedContactDetails' + TransactionalEmailsTemplateDetails: + description: Transactional emails template details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionalEmailsTemplateDetails' + TransactionalEmailsTemplateList: + description: Transactional email templates listing + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailsTemplateListElement' + TransactionalEmailDetails: + description: Transactional email details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionalEmailDetails' + TransactionalEmailStatistics: + description: The overall statistics of transactional emails + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailStatistics' + TransactionalEmailList: + description: The list of transactional emails + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailListElement' + TransactionalEmail: + description: Transactional email. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionalEmail' + FromFieldList: + description: The list of 'From' email addresses ('from fields'). + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FromField' + FromFieldDetails: + description: The 'From' address details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/FromField' + RssNewsletterDetails: + description: The RSS newsletter details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/RssNewsletterDetails' + RssNewsletterList: + description: The list of RSS newsletters. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RssNewsletterListItem' + TaxDetails: + description: The tax details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Tax' + TaxList: + description: The list of taxes + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tax' + CustomEventDetails: + description: The custom event details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEventDetails' + CustomEventsList: + description: The list of custom events + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomEventDetails' + FormVariantList: + description: The list of form variants. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FormVariantDetails' + FormDetails: + description: The form details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/FormDetails' + FormList: + description: The list of forms. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Form' + LandingPageList: + description: The list of landing pages. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BaseLandingPage' + LandingPageDetails: + description: The landing pages details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LandingPage' + ImportList: + description: The list of imports. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Import' + ImportDetails: + description: The import details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Import' + SmsStats: + description: SMS statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsStats' + RevenueStats: + description: Revenue statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/RevenueStatistics' + GeneralPerformanceStats: + description: General performance statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/GeneralPerformanceStats' + PredefinedFieldsList: + description: The list of predefined fields. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PredefinedField' + PredefinedFieldDetails: + description: The predefined field details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/PredefinedField' + CategoryDetails: + description: The category details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Category' + CategoryList: + description: The list of categories + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Category' + SuppressionsList: + description: The suppressions list. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Suppression' + SuppressionDetails: + description: The suppression details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SuppressionDetails' + OrderList: + description: The list of orders + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Order' + OrderDetails: + description: The order details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + SubscriptionConfirmationBodyList: + description: List of subscription confirmation bodies + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SubscriptionConfirmationBody' + SubscriptionConfirmationSubjectList: + description: List of subscription confirmation subjects + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SubscriptionConfirmationSubject' + ProductList: + description: The list of products + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Product' + SimpleProductCategoryList: + description: The list of product categories + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BaseCategory' + ProductDetails: + description: The product details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Product' + ShopList: + description: The list of shops + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + properties: + shopId: + description: The shop ID + type: string + readOnly: true + example: pf3 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3 + name: + description: The shop name + type: string + maxLength: 124 + minLength: 4 + example: Monster market + locale: + description: The language locale (ISO 639-1) + type: string + example: PL + currency: + description: The currency code (ISO 4217) + type: string + example: PLN + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + ShopDetails: + description: The shop details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ShopDetails' + PopupGeneralPerformance: + description: Form or popup statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/PopupGeneralPerformanceStats' + PopupDetails: + description: Form or popup details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/PopupDetails' + PopupsList: + description: The list of forms and popups + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PopupListItem' + SplittestList: + description: The list of A/B tests. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Splittest' + Splittest: + description: A/B test details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Splittest' + CartDetails: + description: The cart details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + CartList: + description: The list of carts + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Cart' + Quota: + description: Storage space information + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Quota' + FileList: + description: The list of files + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/File' + File: + description: The file details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/File' + Folder: + description: The folder details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Folder' + FoldersList: + description: The list of folders + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Folder' + AbtestsSubjectGetDetails: + description: A/B test details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AbtestsSubjectDetails' + AbtestsSubjectGetList: + description: The list of A/B tests + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AbtestsSubjectListItem' + ClickTrack: + description: The click track details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ClickTrackResource' + ClickTrackList: + description: The list of click tracks + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClickTrackResource' + MessageStatisticsListElement: + description: The message statistics. + content: + application/json: + schema: + $ref: '#/components/schemas/MessageStatisticsListElement' + NewsletterDetails: + description: The newsletter details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/NewsletterDetails' + NewsletterList: + description: The list of newsletters. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NewsletterListElement' + NewsletterActivities: + description: The list of newsletters activities + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NewsletterActivity' + TagDetails: + description: The tag details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TagDetails' + TagList: + description: The list of tags + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tag' + AddressList: + description: The list of addresses. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Address' + AddressDetails: + description: The address details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Address' + AccountBlocklist: + description: Blocklist masks for the whole account. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Blocklist' + CampaignBlocklist: + description: Blocklist masks for the campaign. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Blocklist' + CustomFieldDetails: + description: The custom field details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CustomField' + CustomFieldList: + description: The list of custom fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomField' + LpsList: + description: The list of tags + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Lps' + LpsDetails: + description: The landing page details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/LpsDetails' + LpsStats: + description: Landing page statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/LpsStats' + ImageList: + description: Image list + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ImageDetails' + ImageDetails: + description: Image details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ImageDetails' + Tracking: + description: The Tracking Snippets + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tracking' + FacebookPixelList: + description: '"Facebook Pixel" details' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FacebookPixel' + ProductVariantDetails: + description: The product variant details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ProductVariant' + ProductVariantList: + description: The list of product variants + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProductVariant' + AccountBadgeDetails: + description: Account badge status + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AccountBadgeDetails' + SendingLimitsList: + description: Send limits + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SendingLimitsListItem' + IndustryList: + description: Industry tags list + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IndustryTag' + AccountTimezoneList: + description: List of time zones + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Timezone' + AccountLoginHistoryList: + description: Login history information + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AccountsLoginHistoryListElement' + Callback: + description: Callback configuration + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Callback' + AccountDetails: + description: Your account information + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Account' + AccountBillingDetails: + description: Billing information. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AccountBilling' + SubscriptionsByDatesStatisticsList: + description: Subscription statistics by date + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionsByDatesStatisticsList' + CampaignSummaryList: + description: The summary list. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignSummaryList' + CampaignLocationsList: + description: The list of locations. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignLocationsList' + RemovalsByDatesStatisticsList: + description: Subscription statistics by date + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/RemovalsByDatesStatisticsList' + CampaignOriginsList: + description: The list of origins. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignOriginsList' + CampaignListSizesStatisticsList: + description: The campaign data. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignListSizesStatisticsList' + BalanceByDatesStatisticsList: + description: The subscription statistics, shown by date. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/BalanceByDatesStatisticsList' + Campaign: + description: The campaign data. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Campaign' + CampaignList: + description: The list of campaigns. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CampaignListElement' + MetaFieldDetails: + description: The meta field details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/MetaField' + MetaFieldList: + description: The list of meta fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetaField' + LegacyForm: + description: The Legacy Form. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/LegacyForm' + LegacyFormList: + description: The list of Legacy Forms. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LegacyForm' + GDPRFieldList: + description: The list of GDPR fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GDPRField' + GDPRFieldDetails: + description: The details of the GDPR field + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/GDPRFieldDetails' + Workflow: + description: The workflow + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Workflow' + WorkflowList: + description: The list of workflows + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Workflow' + SmsDetails: + description: The SMS message details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsDetails' + SmsAutomationList: + description: The list of the automated SMS messages + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsAutomationListItem' + SmsList: + description: The SMS message listing + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsListItem' + MessageStatisticsList: + description: The list of autoresponders statistic split by time interval. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MessageStatisticsListElement' + SingleMessageStatisticsList: + description: The list of autoresponder statistics split by time interval. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MessageStatisticsListElement' + AutoresponderDetails: + description: The autoresponder details' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AutoresponderDetails' + AutoresponderList: + description: The list of autoresponders. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/AutoresponderList' + WebsitesList: + description: The list of tags + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Website' + WebsiteStats: + description: Website statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/WebsiteStats' + WebsiteDetails: + description: The website details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/WebsiteDetails' + parameters: + webinarId: + name: webinarId + in: path + description: The webinar ID + required: true + schema: + type: string + example: yK6d + contactId: + name: contactId + in: path + description: The contact ID + required: true + schema: + type: string + example: pV3r + searchContactId: + name: searchContactId + in: path + description: The saved search contact identifier + required: true + schema: + type: string + example: pV3r + transactionalTemplateId: + name: transactionalTemplateId + in: path + description: Transactional emails template identifier + required: true + schema: + type: string + example: abc + transactionalEmailId: + name: transactionalEmailId + in: path + required: true + schema: + type: string + example: tRe4i + fromFieldId: + name: fromFieldId + in: path + description: The 'From' address ID + required: true + schema: + type: string + example: TTzW + rssNewsletterId: + name: rssNewsletterId + in: path + description: The RSS newsletter ID + required: true + schema: + type: string + example: dGer + taxId: + name: taxId + in: path + description: The tax ID + required: true + schema: + type: string + example: Sk + customEventId: + name: customEventId + in: path + description: The custom event ID + required: true + schema: + type: string + example: hp2 + formId: + name: formId + in: path + description: The form ID + required: true + schema: + type: string + example: pL4e + landingPageId: + name: landingPageId + in: path + description: The landing page ID. + required: true + schema: + type: string + example: avYn + importId: + name: importId + in: path + description: The import ID + required: true + schema: + type: string + example: o6gE + predefinedFieldId: + name: predefinedFieldId + in: path + description: The predefined field identifier + required: true + schema: + type: string + example: 6neM + categoryId: + name: categoryId + in: path + description: The category ID + required: true + schema: + type: string + example: C3s + suppressionId: + name: suppressionId + in: path + description: The suppression ID + required: true + schema: + type: string + example: pypF + orderId: + name: orderId + in: path + description: The order ID + required: true + schema: + type: string + example: fOh + languageCode: + name: languageCode + in: path + description: ISO 639-1 Language Code Standard + required: true + schema: + type: string + example: en + productId: + name: productId + in: path + description: The product ID + required: true + schema: + type: string + example: 9I + shopId: + name: shopId + in: path + description: The shop ID + required: true + schema: + type: string + example: pf3 + popupId: + name: popupId + in: path + description: The form or popup ID + required: true + schema: + type: string + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + splittestId: + name: splittestId + in: path + description: The send settings for the A/B test + required: true + schema: + type: string + example: 9I + cartId: + name: cartId + in: path + description: The cart ID + required: true + schema: + type: string + example: V + fileId: + name: fileId + in: path + description: The file ID + required: true + schema: + type: string + example: 6Yh + folderId: + name: folderId + in: path + description: The folder ID + required: true + schema: + type: string + example: Pa5 + abTestId: + name: abTestId + in: path + description: A/B test ID + required: true + schema: + type: string + example: xyz + clickTrackId: + name: clickTrackId + in: path + required: true + schema: + type: string + example: C12t + newsletterId: + name: newsletterId + in: path + description: The newsletter ID + required: true + schema: + type: string + example: 'N' + tagId: + name: tagId + in: path + description: The tag ID + required: true + schema: + type: string + example: vBd5 + addressId: + name: addressId + in: path + description: The address ID + required: true + schema: + type: string + example: k9 + customFieldId: + name: customFieldId + in: path + description: The custom field ID + required: true + schema: + type: string + example: pas + lpsId: + name: lpsId + in: path + description: The landing page ID + required: true + schema: + type: string + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + variantId: + name: variantId + in: path + description: The variant ID + required: true + schema: + type: string + example: VTB + campaignId: + name: campaignId + in: path + description: The campaign ID + required: true + schema: + type: string + example: 3Va2e + CampaignStatisticsIdQuery: + name: query[campaignId] + in: query + required: true + schema: + $ref: '#/components/schemas/CampaignStatisticsIdQuery' + CampaignStatisticsGroupByQuery: + name: query[groupBy] + in: query + required: false + schema: + type: string + enum: + - hour + - day + - month + - total + example: month + CampaignStatisticsDateFromQuery: + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + CampaignStatisticsDateToQuery: + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + metaFieldId: + name: metaFieldId + in: path + description: The metafield ID + required: true + schema: + type: string + example: hgF + webformId: + name: webformId + in: path + description: The webform (Legacy Form) ID + required: true + schema: + type: string + example: 3Va2e + gdprFieldId: + name: gdprFieldId + in: path + description: The GDPR field ID + required: true + schema: + type: string + example: MtY + workflowId: + name: workflowId + in: path + description: The workflow ID + required: true + schema: + type: string + example: 3Va2e + smsId: + name: smsId + in: path + description: The SMS message ID + required: true + schema: + type: string + example: 'N' + autoresponderId: + name: autoresponderId + in: path + description: The autoresponder ID. + required: true + schema: + type: string + example: Q + websiteId: + name: websiteId + in: path + description: The website ID + required: true + schema: + type: string + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + PerPage: + name: perPage + in: query + description: Requested number of results per page + required: false + schema: + type: integer + format: int32 + default: 100 + maximum: 1000 + minimum: 1 + Page: + name: page + in: query + description: Page number + required: false + schema: + type: integer + format: int32 + default: 1 + minimum: 1 + Fields: + name: fields + in: query + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + required: false + schema: + type: string + requestBodies: + NewShop: + content: + application/json: + schema: + $ref: '#/components/schemas/NewShop' + NewCategory: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCategory' + UpdateCategory: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCategory' + UpdateShop: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateShop' + NewMetaField: + content: + application/json: + schema: + $ref: '#/components/schemas/NewMetaField' + NewProduct: + content: + application/json: + schema: + $ref: '#/components/schemas/NewProduct' + UpdateProduct: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateProduct' + UpsertProductCategory: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertProductCategory' + UpsertMetaField: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertMetaField' + UpdateMetaField: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMetaField' + NewProductVariant: + content: + application/json: + schema: + $ref: '#/components/schemas/NewProductVariant' + UpdateProductVariant: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateProductVariant' + NewTax: + content: + application/json: + schema: + $ref: '#/components/schemas/NewTax' + UpdateTax: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateTax' + NewAddress: + content: + application/json: + schema: + $ref: '#/components/schemas/NewAddress' + UpdateAddress: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAddress' + NewOrder: + content: + application/json: + schema: + $ref: '#/components/schemas/NewOrder' + UpdateOrder: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateOrder' + NewCart: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCart' + UpdateCart: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCart' + NewSearchContacts: + content: + application/json: + schema: + $ref: '#/components/schemas/NewSearchContacts' + UpdateSearchContacts: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSearchContacts' + SearchContactsConditionsDetails: + content: + application/json: + schema: + $ref: '#/components/schemas/SearchContactsConditionsDetails' + CreateTransactionalEmail: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTransactionalEmail' + CreateTransactionalEmailTemplate: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTransactionalEmailTemplate' + updateTransactionalEmailsTemplate: + content: + application/json: + schema: + properties: + subject: + description: The template subject + type: string + example: Order Confirmation - Example Shop + content: + $ref: '#/components/schemas/TransactionalEmailTemplateContent' + type: object + NewFromField: + content: + application/json: + schema: + $ref: '#/components/schemas/NewFromField' + NewCampaign: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCampaign' + UpdateCampaign: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCampaign' + UpdateAccount: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAccount' + NewAutoresponder: + content: + application/json: + schema: + $ref: '#/components/schemas/NewAutoresponder' + UpdateAutoresponder: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAutoresponder' + NewRssNewsletter: + content: + application/json: + schema: + $ref: '#/components/schemas/NewRssNewsletter' + UpdateRssNewsletter: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRssNewsletter' + NewContact: + content: + application/json: + schema: + $ref: '#/components/schemas/NewContact' + UpsertContactCustomFields: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertContactCustomFields' + UpsertContactTags: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertContactTags' + UpdateContact: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateContact' + NewCustomField: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCustomField' + UpdateCustomField: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCustomField' + NewSuppression: + content: + application/json: + schema: + $ref: '#/components/schemas/NewSuppression' + UpdateSuppression: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSuppression' + NewPredefinedField: + content: + application/json: + schema: + $ref: '#/components/schemas/NewPredefinedField' + UpdatePredefinedField: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePredefinedField' + UpdateCallbacks: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCallbacks' + TriggerCustomEvent: + content: + application/json: + schema: + $ref: '#/components/schemas/TriggerCustomEvent' + NewCustomEvent: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCustomEvent' + UpdateCustomEvent: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCustomEvent' + NewImport: + content: + application/json: + schema: + $ref: '#/components/schemas/NewImport' + NewFile: + content: + application/json: + schema: + $ref: '#/components/schemas/NewFile' + NewFolder: + content: + application/json: + schema: + $ref: '#/components/schemas/NewFolder' + NewAbtestsSubject: + content: + application/json: + schema: + $ref: '#/components/schemas/NewAbtestsSubject' + ChooseWinnerAbtestsSubject: + content: + application/json: + schema: + $ref: '#/components/schemas/ChooseWinnerAbtestsSubject' + SendNewsletterDraft: + content: + application/json: + schema: + $ref: '#/components/schemas/SendNewsletterDraft' + NewNewsletter: + content: + application/json: + schema: + $ref: '#/components/schemas/NewNewsletter' + NewTag: + content: + application/json: + schema: + $ref: '#/components/schemas/NewTag' + UpdateTag: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateTag' + UpdateAccountBlocklist: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlocklist' + UpdateCampaignBlocklist: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlocklist' + CreateMultimedia: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/CreateMultimedia' + UpdateAccountBadge: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAccountBadge' + UpdateWorkflow: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateWorkflow' + headers: + CurrentPage: + description: The current page number + schema: + type: integer + format: int32 + TotalPages: + description: The total number of pages + schema: + type: integer + format: int32 + TotalCount: + description: The total number of resources found for the specified conditions + schema: + type: integer + format: int32 + RateLimitLimit: + description: The total number of requests available per time frame + schema: + type: integer + format: int32 + RateLimitRemaining: + description: The number of requests left in the current time frame + schema: + type: integer + format: int32 + RateLimitReset: + description: Seconds left in the current time frame, e.g. "432 seconds" + schema: + type: string + securitySchemes: + api-key: + type: apiKey + description: Header value must be prefixed with api-key + name: X-Auth-Token + in: header + oauth2: + type: oauth2 + flows: + implicit: + authorizationUrl: https://app.getresponse.com/oauth2_authorize.html + scopes: + all: all data access + authorizationCode: + authorizationUrl: https://app.getresponse.com/oauth2_authorize.html + tokenUrl: https://api.getresponse.com/v3/token + scopes: + all: all data access + clientCredentials: + tokenUrl: https://api.getresponse.com/v3/token + scopes: + all: all data access +tags: + - name: Webinars + - name: Contacts + - name: Search Contacts + - name: Transactional Email Templates + - name: Transactional Emails + - name: From Fields + - name: RSS Newsletters + - name: Taxes + - name: Custom Events + - name: Forms + - name: Legacy Landing Pages + - name: Imports + - name: Predefined Fields + - name: Categories + - name: Suppressions + - name: Orders + - name: Subscription Confirmations + - name: Products + - name: Shops + - name: Forms and Popups + - name: A/B tests + - name: Carts + - name: File Library + - name: A/B tests - subject + - name: Click Tracks + description: >- + Click tracking refers to the data collected about each link click, such as + how many people clicked it, how many clicks resulted in desired actions + such as sales, forwards or subscriptions. + - name: Newsletters + - name: Tags + - name: Addresses + - name: Custom Fields + - name: New Landing Pages + - name: Multimedia + - name: Tracking + - name: Product Variants + - name: Accounts + - name: Campaigns (Lists) + description: >- + Our API v3 uses the terminology from the previous version of GetResponse. + + + **Campaigns and lists are the same resource under a different name.** For + now, please refer to lists as campaigns. + + + Our API v4 will use the updated terminology. + - name: Meta Fields + - name: Legacy Forms + - name: Workflows + - name: SMS Automation Messages + - name: SMS Messages + - name: Autoresponders + - name: Websites +externalDocs: + description: Find out more about API + url: https://apidocs.getresponse.com +x-tagGroups: + - name: User + tags: + - Accounts + - Multimedia + - File Library + - name: Contacts + tags: + - Campaigns (Lists) + - Contacts + - Custom Fields + - Search Contacts + - Subscription Confirmations + - Predefined Fields + - Suppressions + - Imports + - name: Email Marketing + tags: + - Newsletters + - Autoresponders + - RSS Newsletters + - Legacy Landing Pages + - From Fields + - A/B tests + - A/B tests - subject + - Click Tracks + - name: Tags + tags: + - Tags + - name: GDPR Fields + tags: + - GDPR Fields + - name: Forms and surveys + tags: + - Legacy Forms + - Forms + - name: Automation + tags: + - Workflows + - Custom Events + - Tracking + - name: Ecommerce + tags: + - Addresses + - Carts + - Categories + - Meta Fields + - Orders + - Products + - Product Variants + - Shops + - Taxes + - name: Transactional Emails + tags: + - Transactional Emails + - Transactional Emails Templates + - name: SMS + tags: + - SMS Messages + - SMS Automation Messages + - name: Statistics + tags: + - Ecommerce + - Sms + - Website + - Landing Page + - Form and Popup + - name: Webinars + tags: + - Webinars + - name: Websites + tags: + - Websites + - Landing Pages + - name: Forms and Popups + tags: + - Forms and Popups diff --git a/sdks/db/fixed-specs-cache/get-response-fixed-spec.yaml b/sdks/db/fixed-specs-cache/get-response-fixed-spec.yaml new file mode 100644 index 0000000000..7cae3cf55e --- /dev/null +++ b/sdks/db/fixed-specs-cache/get-response-fixed-spec.yaml @@ -0,0 +1,35084 @@ +publishJson: + company: GetResponse + serviceName: false + sdkName: get-response-{language}-sdk + clientName: GetResponse + metaDescription: >- + GetResponse is a comprehensive email marketing platform that provides small + businesses, solopreneurs, coaches, and marketers with powerful and + affordable tools to grow their audience, engage with their subscribers, and + turn subscribers into paying customers. With over 25 years of expertise, our + customers choose GetResponse for our user-friendly solution, award-winning + 24/7 customer support, and powerful tools that go beyond email marketing – + with automation, list growth, and additional communication tools like + webinars and live chats to help businesses build their personal brand, sell + their products and services, and build a community. + + + GetResponse's powerful email marketing software includes AI-enhanced content + creation tools, professional templates, easy-to-use design tools, and proven + deliverability. Our customers are empowered with tools to build a website + and unlimited landing pages, and create engaging pop-ups and signup forms. + The marketing automation builder brings your ideal automated communication + scenario to life with a visual builder that can grow with your needs. + + + With our easy-to-use platform, proven expertise, and focus on user-friendly + solutions, GetResponse is the ideal tool for small businesses, solopreneurs, + coaches, and marketers looking to grow their audience, sell their products + and services, and engage with their subscribers in a meaningful way. + apiStatusUrls: inherit + homepage: getresponse.com + developerDocumentation: apireference.getresponse.com/ + categories: + - email + - marketing + - email_marketing + - marketing_automation + - webinar_funnels +rawSpecString: | + openapi: 3.0.0 + info: + title: GetResponse APIv3 + description: > + + + # Limits and throttling + + + GetResponse API calls are subject to throttling to ensure a high level of + service for all users. + + + ## Time frame + + + Time frame is a period of time for which we calculate the API call limits. + The limits reset in every time frame. + + + The time frame duration is **10 minutes**. + + + ## Basic rate limits + + + Each user is allowed to make **30,000 API calls per time frame** (10 + minutes) and **80 API calls per second**. + + + ## Parallel requests limit + + + It is possible to send up to **10 simultaneous requests**. + + + ## Headers + + + Every API response includes a few additional headers: + + + * `X-RateLimit-Limit` – the total number of requests available per time + frame + + * `X-RateLimit-Remaining` – the number of requests left in the current + time frame + + * `X-RateLimit-Reset` – seconds left in the current time frame + + + ## Errors + + + The **429 Too Many Requests** HTTP response code indicates that the limit + has been reached. The error response includes `currentLimit` and + `timeToReset` fields in the context section, with the total number of + requests available per time frame and seconds left in the current time frame + respectively. + + + ## Reaching the limit + + + When you reach the limit, you need to wait for the time specified in + `timeToReset` field or `X-RateLimit-Reset` header before making another + request. + + + # Authentication + + + API can be accessed by authenticated users only. This means that every + request must be signed with your credentials. We offer two methods of + authentication: API Key and OAuth 2.0. API key is our primary method and + should be used in most cases. GetResponse MAX clients have to send an + `X-Domain` header in addition to the API key. Supported OAuth 2.0 flows are: + Authorization Code, Client Credentials, Implicit, and Refresh Token. + + + ## API key + + + Follow these steps to send an authentication request: + + + * Find your unique and secret API key in the panel: + [https://app.getresponse.com/api](https://app.getresponse.com/api) + + * Add a custom `X-Auth-Token` header to all your requests. For example, if + your API key is `jfgs8jh4ksg93ban9Dfgh8`, the header will look like this: + + + ``` + + X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8 + + ``` + + + **For security reasons, unused API keys expire after 90 days. When that + happens, you’ll need to generate a new key to use our API.** + + + ### Example authenticated request + + + ``` + + $ curl -H "X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8" + https://api.getresponse.com/v3/accounts + + ``` + + + ## OAuth 2.0 + + + To use OAuth 2.0 authentication, you need to get an "Access Token". For more + information on how to obtain a token, head to our dedicated page: [OAuth + 2.0](/#section/Authentication/Using-OAuth-2.0) + + + To authenticate a request using an Access Token, set the value of + `Authorization` header to "Bearer" followed by the Access Token. + + + ### Example + + + If the Access Token is `jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8` + + + ``` + + Authorization: Bearer jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8 + + ``` + + + ## GetResponse MAX + + + GetResponse MAX customers need to take an extra step to authenticate the + request. All requests have to be send with an `X-Domain` header that + contains the client's domain. For example: + + + ``` + + X-Domain: example.com + + ``` + + + Please note that the header must contain only the domain name, without the + protocol identifier (`http://` or `https://`). + + + ## Using OAuth 2.0 + + + ### Registering your own application + + + If you want to use an OAuth flow to authorize your application, first + [register your application](https://app.getresponse.com/authorizations) + + + You need to provide a name, short description, and redirect URL. + + + ### Choosing grant flow + + + Once your application is registered, you can click on it to see your + `client_id` and `client_secret`. They're basically a login and password for + your application's access, so be sure not to share them with anyone. + + + Next, decide which authentication flow (grant type) you want to use. Here + are your options: + + + - choose the **Authorization Code** flow if your application is server-based + (you have a server with its own domain and server-side code), + + - choose the **Implicit** flow if your application is based mostly on + JavaScript or client-side code, + + - choose the **Client Credential** flow if you want to test your application + or access your GetResponse account, + + - implement the **Refresh Token** flow to handle token expiration if you use + the Authorization Code flow. + + + ### Authorization Code flow + + + First, your application must redirect a resource owner to the following URL: + + + ``` + + https://app.getresponse.com/oauth2_authorize.html?response_type=code&client_id=_your_client_id_&state=xyz + + ``` + + + The `state` parameter is there for security reasons and should be a random + string. When the resource owner grants your application access to the + resource, we will redirect the browser to the `redirect URL` you specified + in the application settings and attach the same state as the parameter. + Comparing the state parameter value ensures that the redirect was initiated + by our system. The code parameter is an authorization code that you can + exchange for an access token within 10 minutes, after which time it expires. + + + #### Example redirect with authorization code + + + ``` + + https://myredirecturi.com/cb?code=ed17c498bfe343175cd7684c5b09979f2875b25c&state=xyz + + ``` + + + #### Exchanging authorization code for the access token + + + Here's an example request to exchange authorization code for the access + token: + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=authorization_code&code=ed17c498bfe343175cd7684c5b09979f2875b25c' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + ##### Example response + + + ```json + + { + "access_token": "03807cb390319329bdf6c777d4dfae9c0d3b3c35", + "expires_in": 3600, + "token_type": "Bearer", + "scope": null, + "refresh_token": "170d9f64e781aaa6b3ba036083faba71b2fc4e6c" + } + + ``` + + + ### Client Credentials flow + + + This flow is suitable for development, when you need to quickly access API + to create some functionality. You can get the access token with a single + request: + + + #### Request + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=client_credentials' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + #### Response + + + ```json + + { + "access_token": "e2222af2851a912470ec33c9b4de1ea3a304b7d7", + "expires_in": 86400, + "token_type": "Bearer", + "scope": null + } + + ``` + + + You can also go to https://app.getresponse.com/manage_api.html, click the + action button for your application, and select "generate credentials". This + will open a popup with a generated access token. You can then use the access + token to authenticate your requests, for example: + + + ``` + + $ curl -H "Authorization: Bearer e2222af2851a912470ec33c9b4de1ea3a304b7d7" + https://api.getresponse.com/v3/from-fields + + ``` + + + ### Implicit flow + + + First, your application must redirect a resource owner to the following URL: + + + ``` + + https://app.getresponse.com/oauth2_authorize.html?response_type=token&client_id=_your_client_id_&redirect_uri=https://myredirecturi.com/cb&state=xyz + + ``` + + + When the resource owner grants your application access to the resource, we + will redirect the owner to the URL that was specified in the request. + + + There is no code exchange process because, unlike the Authorization Code + flow, the redirect already has the access token in the parameters. + + + ``` + + https://myredirecturi.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA&state=xyz&token_type=bearer&expires_in=3600 + + ``` + + + ### Refresh Token flow + + + You need to refresh your access token if you receive this error message as a + response to your request: + + + ```json + + { + "httpStatus": 401, + "code": 1014, + "codeDescription": "Problem during authentication process, check headers!", + "message": "The access token provided is expired", + "moreInfo": "https://apidocs.getresponse.com/v3/errors/1014", + "context": { + "sentToken": "b8b1e961a7f9fd4cc710d5d955e09c15a364ab71" + } + } + + ``` + + + If you are using the Authorization Code flow, you need to use the refresh + token to issue a new access token/refresh token pair by making the following + request: + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=refresh_token&refresh_token=170d9f64e781aaa6b3ba036083faba71b2fc4e6c' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + The response you'll get will look like this: + + + ```json + + { + "access_token": "890fdsa2f5d7b189fc4e6c4b1d170d9f591238ss", + "expires_in": 86400, + "token_type": "Bearer", + "scope": null, + "refresh_token": "170d9f64e781aaa6b3ba036083faba71b2fc4e6c" + } + + ``` + + + ### GetResponse MAX + + + There are some differences when authenticating GetResponse MAX users: + + + - the application must redirect to a page in the client's custom domain, for + example: `https://custom-domain.getresponse360.com/oauth2_authorize.html` + + - token requests have to be send to one of the GetResponse MAX APIv3 + endpoints (depending on the client's environment), + + - token requests have to include an `X-Domain` header, + + - the application has to be registered in a GetResponse MAX account within + the same environment. + + + + # CORS (AJAX requests) + + + [Cross-Origin Resource Sharing + (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) mechanism is + not supported by APIv3. It means that AJAX requests to the API will be + blocked by the browser's [same-origin + policy](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy). + Please use a server-side application to access the API. + + + + # Timezone settings + + + The default timezone in response data is **UTC**. + + + To set a different timezone, add `X-Time-Zone` header with value of [time + zone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) + ("TZ database name" column). + + + + # Pagination + + + Most of the resource collections returned by API are paginated. It means + that the response is divided into multiple pages. + + + Control the number of results on each page by using `perPage` query + parameter and change pages by using `page` query parameter. + + + By default we return only the first **100** resources per page. You can + change that by adding `perPage` parameter with a value of up to **1000**. + + + Page numbers start with **1**. + + + Paginated responses have 3 extra headers: + + * `TotalCount` – a total number of resources on all pages + + * `TotalPages` – a total number of pages + + * `CurrentPage` – current page number + + + Use the maximum `perPage` value (**1000**) if you plan to iterate over all + the pages of the response. + + + When trying to get a page that exceeds the total number of pages, API will + return an empty array (`[]`). Make sure to stop iterating when it happens. + + + + # CURLE_SSL_CACERT error + + + Solution to CURLE_SSL_CACERT error (code 60). + + + This error is related to expired CA (Certificate Authority) certificates + installed on your server (the server that you send the requests from). You + can read more about certificate verification on the [cURL project + website](https://curl.haxx.se/docs/sslcerts.html). + + + If you encounter this error while sending requests to the GetResponse APIv3, + ask your server administrator to update the CA certificates using the + [latest bundle provided by the cURL + project](https://curl.haxx.se/docs/caextract.html). + + + **Please make sure that cURL is configured to use the updated bundle.** + contact: + name: API Support - DevZone + url: https://app.getresponse.com/feedback.html?devzone=yes + email: getresponse-devzone@cs.getresponse.com + version: 3.2024-03-04T09:53:07+0000 + x-logo: + url: https://us-ws.gr-cdn.com/images/global/getresponse.png + servers: + - url: https://api.getresponse.com/v3 + description: GetResponse + - url: https://api3.getresponse360.com/v3 + description: GetResponse MAX US + - url: https://api3.getresponse360.pl/v3 + description: GetResponse MAX PL + paths: + /webinars/{webinarId}: + get: + tags: + - Webinars + summary: Get a webinar by ID + operationId: getWebinarById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/WebinarDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/webinarId' + /contacts/{contactId}: + get: + tags: + - Contacts + summary: Get contact details by contact ID + operationId: getContactById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ContactDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Contacts + summary: Update contact details + description: >- + Skip the fields you don't want to update. If tags and custom fields are + provided, they'll be **replaced** with the values sent in this request. + If the `campaignId` changes, the contact will be moved from the original + campaign (list) to the new campaign (list). Their activity history and + statistics will also be moved. + operationId: updateContact + requestBody: + $ref: '#/components/requestBodies/UpdateContact' + responses: + '200': + $ref: '#/components/responses/ContactDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Contacts + summary: Delete a contact by contact ID + operationId: deleteContact + parameters: + - name: messageId + in: query + description: >- + > + + The ID of a message (such as a newsletter, an autoresponder, or an + RSS-newsletter). + + When passed, this method will simulate the unsubscribe process, as + if the contact clicked the unsubscribe link in a given message. + required: false + schema: + type: string + - name: ipAddress + in: query + description: >- + This makes it possible to pass the IP from which the contact + unsubscribed. Used only if the `messageId` was send. + schema: + type: string + format: ipv4 + responses: + '204': + description: Empty response. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/contactId' + /contacts/{contactId}/activities: + get: + tags: + - Contacts + summary: Get a list of contact activities + description: >- + By default, only activities from the last 14 days are returned. To get + earlier data, use `query[createdOn]` parameter. You can filter the + resource using criteria specified as `query[*]`. You can provide + multiple criteria, to use AND logic. You can sort the resource using + parameters specified as `sort[*]`. You can specify multiple fields to + sort by. + operationId: getActivities + parameters: + - name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ContactActivityList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/contactId' + /campaigns/{campaignId}/contacts: + get: + tags: + - Contacts + summary: Get contacts from a single campaign + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getContactsFromCampaign + parameters: + - name: query[email] + in: query + description: Search contacts by email + required: false + schema: + type: string + - name: query[name] + in: query + description: Search contacts by name + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[email] + in: query + description: Sort contacts by email + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + description: Sort contacts by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort contacts by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ContactList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/campaignId' + /contacts/{contactId}/custom-fields: + post: + tags: + - Contacts + summary: Upsert the custom fields of a contact + description: >- + Upsert (add or update) the custom fields of a contact. This method + doesn't remove (unassign) custom fields. + operationId: upsertContactCustoms + requestBody: + $ref: '#/components/requestBodies/UpsertContactCustomFields' + responses: + '200': + $ref: '#/components/responses/ContactCustomFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: upsert + parameters: + - $ref: '#/components/parameters/contactId' + /contacts/{contactId}/tags: + post: + tags: + - Contacts + summary: Upsert the tags of a contact + description: >- + Upsert (add or update) the tags of a contact. This method doesn't remove + (unassign) tags. + operationId: upsertTags + requestBody: + $ref: '#/components/requestBodies/UpsertContactTags' + responses: + '200': + $ref: '#/components/responses/UpsertContactTags' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: upsert + parameters: + - $ref: '#/components/parameters/contactId' + /search-contacts/{searchContactId}: + get: + tags: + - Search Contacts + summary: Get search contacts by contact ID. + description: Get the definition of a specific contact-search filter. + operationId: getSearchContactsById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SearchContactsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Search Contacts + summary: Update search contacts + description: Update specified search contacts. + operationId: updateSearchContacts + requestBody: + $ref: '#/components/requestBodies/UpdateSearchContacts' + responses: + '200': + $ref: '#/components/responses/SearchContactsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Search Contacts + summary: Delete search contacts + operationId: deleteSearchContacts + responses: + '204': + description: Delete search contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/searchContactId' + /search-contacts/{searchContactId}/contacts: + get: + tags: + - Search Contacts + summary: Get contacts by search contacts ID + description: Get contacts from saved search contacts by ID. + operationId: getContactsByIdSearchContacts + parameters: + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - name: sort[email] + in: query + description: Sort by email + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - name: sort[createdOn] + in: query + description: Sort by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: asc + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SearchedContactsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/searchContactId' + /search-contacts/{searchContactId}/custom-fields: + post: + tags: + - Search Contacts + summary: Upsert custom fields by search contacts + description: >- + Makes it possible to add and update custom field values for all contacts + that meet the search criteria. This method doesn't remove or overwrite + custom fields with the values from the request. + operationId: upsertCustomFieldsBySearchContactId + requestBody: + $ref: '#/components/requestBodies/UpsertContactCustomFields' + responses: + '202': + description: Upsert custom fields by searchContactId. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: UpsertCustomFieldsBySearchContactsId + parameters: + - $ref: '#/components/parameters/searchContactId' + /transactional-emails/templates/{transactionalTemplateId}: + get: + tags: + - Transactional Emails Templates + summary: Get a single template by ID + operationId: getTransactionalEmailsTemplatesById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailsTemplateDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + post: + tags: + - Transactional Emails Templates + summary: Update transactional email template + description: This method allows you to update transactional email template + operationId: updateTransactionalEmailsTemplate + requestBody: + $ref: '#/components/requestBodies/updateTransactionalEmailsTemplate' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailsTemplateDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + delete: + tags: + - Transactional Emails Templates + summary: Delete transactional email template + operationId: deleteTransactionalEmailsTemplate + responses: + '204': + description: Delete transactional email template + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + parameters: + - $ref: '#/components/parameters/transactionalTemplateId' + /transactional-emails/{transactionalEmailId}: + get: + tags: + - Transactional Emails + summary: Get transactional email details by transactional email ID + operationId: getTransactionalEmailsById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + parameters: + - $ref: '#/components/parameters/transactionalEmailId' + /from-fields/{fromFieldId}: + get: + tags: + - From Fields + summary: Get a single 'From' address by ID + operationId: getFromFieldById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/FromFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - From Fields + summary: Delete 'From' address + operationId: deleteFromField + parameters: + - name: fromFieldIdToReplaceWith + in: query + description: The 'From' address ID that should replace the deleted 'From' address + required: false + schema: + type: string + responses: + '204': + description: Delete 'From' address. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/fromFieldId' + /from-fields/{fromFieldId}/default: + post: + tags: + - From Fields + summary: Set a 'From' address as default + operationId: setFromFieldAsDefault + responses: + '200': + description: Set a 'From' address as default. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: SetDefaultFromField + x-no-body: true + x-type: update + parameters: + - $ref: '#/components/parameters/fromFieldId' + /rss-newsletters/{rssNewsletterId}: + get: + tags: + - RSS Newsletters + summary: Get RSS newsletter by ID + operationId: getRssNewsletterById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/RssNewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - RSS Newsletters + summary: Update RSS newsletter + operationId: updateRssNewsletter + requestBody: + $ref: '#/components/requestBodies/UpdateRssNewsletter' + responses: + '200': + $ref: '#/components/responses/RssNewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - RSS Newsletters + summary: Delete RSS newsletter + operationId: deleteRssNewsletter + responses: + '204': + description: Delete RSS newsletter. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/rssNewsletterId' + /rss-newsletters/{rssNewsletterId}/statistics: + get: + tags: + - RSS Newsletters + summary: Get RSS newsletter statistics by ID + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getSingleRssNewsletterStatisticsCollection + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SingleMessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetRssNewsletterStatistics + parameters: + - $ref: '#/components/parameters/rssNewsletterId' + /shops/{shopId}/taxes: + get: + tags: + - Taxes + summary: Get a list of taxes + description: >- + + Sending **GET** request to this URL returns a collection of tax + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below, in the request params + section). You can basically search by: + * name + * createdOn + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getTaxList + parameters: + - name: query[name] + in: query + description: Search tax by name + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search tax created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search tax created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TaxList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Taxes + summary: Create tax + description: > + + Sending a **POST** request to this URL will create a new tax resource. + + + In order to create a new tax, you need to send a tax resource in the + body of the request (remember that you need to serialize the body into a + JSON string) + operationId: createTax + requestBody: + $ref: '#/components/requestBodies/NewTax' + responses: + '201': + $ref: '#/components/responses/TaxDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: CreateTax + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/taxes/{taxId}: + get: + tags: + - Taxes + summary: Get a single tax by ID + description: > + + This method returns tax with a given `taxId` in the context of a given + `shopId` + operationId: getTaxById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TaxDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetTax + post: + tags: + - Taxes + summary: Update tax + description: > + + Update the properties of the shop tax. You should only send the fields + that need to be changed. The rest of the properties will stay the same. + operationId: updateTax + requestBody: + $ref: '#/components/requestBodies/UpdateTax' + responses: + '200': + $ref: '#/components/responses/TaxDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: UpdateTax + delete: + tags: + - Taxes + summary: Delete tax by ID + description: '' + operationId: deleteTax + responses: + '204': + description: Delete tax + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: DeleteTax + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/taxId' + /custom-events/{customEventId}: + get: + tags: + - Custom Events + summary: Get custom events by custom event ID + operationId: getCustomEventById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CustomEventDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Custom Events + summary: Update custom event details + operationId: updateCustomEvent + requestBody: + $ref: '#/components/requestBodies/UpdateCustomEvent' + responses: + '200': + $ref: '#/components/responses/CustomEventDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Custom Events + summary: Delete a custom event by custom event ID + operationId: deleteCustomEvent + responses: + '204': + description: Delete custom event + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/customEventId' + /forms/{formId}: + get: + tags: + - Forms + summary: Get form by ID + operationId: getForm + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/FormDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/formId' + /forms/{formId}/variants: + get: + tags: + - Forms + summary: Get the list of form variants (A/B tests) + operationId: getFormVariantList + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/FormVariantList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/formId' + /landing-pages/{landingPageId}: + get: + tags: + - Legacy Landing Pages + summary: Get single landing page by ID + operationId: getLandingPageById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LandingPageDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/landingPageId' + /imports/{importId}: + get: + tags: + - Imports + summary: Get import details by ID. + operationId: getImportById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ImportDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/importId' + /statistics/sms/{smsId}: + get: + tags: + - Sms + summary: Get details for the SMS message statistics + operationId: getSmsStats + parameters: + - name: query[createdOn][from] + in: query + description: Get statistics for a single SMS from this date + schema: + type: string + format: date + example: '2023-01-20' + - name: query[createdOn][to] + in: query + description: Get statistics for a single SMS to this date + schema: + type: string + format: date + example: '2023-01-20' + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SmsStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + parameters: + - $ref: '#/components/parameters/smsId' + /predefined-fields/{predefinedFieldId}: + get: + tags: + - Predefined Fields + summary: Get a predefined field by ID + description: Get detailed information about a specified predefined field. + operationId: getPredefinedFieldById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/PredefinedFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Predefined Fields + summary: Update a predefined field + operationId: updatePredefinedField + requestBody: + $ref: '#/components/requestBodies/UpdatePredefinedField' + responses: + '200': + $ref: '#/components/responses/PredefinedFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Predefined Fields + summary: Delete a predefined field + operationId: deletePredefinedField + responses: + '204': + description: Delete a predefined field. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/predefinedFieldId' + /shops/{shopId}/categories: + get: + tags: + - Categories + summary: Get the shop categories list + description: >- + + Sending a **GET** request to this URL returns a collection of category + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + *name + * createdOn + * parentId + + The `name` fields can be a pattern and we'll try to match this phrase. + + + The `parentId` will search for sub-categories of a given parent + category. + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getCategories + parameters: + - name: query[name] + in: query + description: Search category by name + required: false + schema: + type: string + - name: query[parentId] + in: query + description: Search categories by their parent + required: false + schema: + type: string + - name: query[externalId] + in: query + description: Search categories by external ID + required: false + schema: + type: string + - name: search[createdAt][from] + in: query + description: Show categories starting from this date + required: false + schema: + type: string + format: date-time + - name: search[createdAt][to] + in: query + description: Show categories starting to this date + required: false + schema: + type: string + format: date-time + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdAt] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CategoryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Categories + summary: Create category + description: >+ + + Create shop category. You can pass the `parentId` parameter to create a + sub-category of a given parent. Unlike most **POST** methods, this call + is idempotent, that is: sending the same request 10 times will not + create 10 new categories. Only one category will be created. + + operationId: createCategory + requestBody: + $ref: '#/components/requestBodies/NewCategory' + responses: + '201': + $ref: '#/components/responses/CategoryDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/categories/{categoryId}: + get: + tags: + - Categories + summary: Get a single category by ID + description: | + + This method returns a category according to the given `categoryId`. + operationId: getCategory + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CategoryDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Categories + summary: Update category + description: >+ + + Update the properties of the shop category. You can specify a `parentId` + to assign a category as sub-category for an existing category. You + should send only those fields that need to be changed. The rest of the + properties will stay the same. + + operationId: updateCategory + requestBody: + $ref: '#/components/requestBodies/UpdateCategory' + responses: + '200': + $ref: '#/components/responses/CategoryDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Categories + summary: Delete category + description: '' + operationId: deleteCategory + responses: + '204': + description: Delete category + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/categoryId' + /suppressions/{suppressionId}: + get: + tags: + - Suppressions + summary: Get a suppression list by ID + operationId: getSuppressionById + responses: + '200': + $ref: '#/components/responses/SuppressionDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Suppressions + summary: Update a suppression list by ID + operationId: updateSuppression + requestBody: + description: The suppression list to be updated. + $ref: '#/components/requestBodies/UpdateSuppression' + responses: + '200': + $ref: '#/components/responses/SuppressionDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Suppressions + summary: Deletes a given suppression list by ID + operationId: deleteSuppression + responses: + '204': + description: Suppression list deleted successfully. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/suppressionId' + /shops/{shopId}/orders: + get: + tags: + - Orders + summary: Get the list of orders + description: >- + + Sending a **GET** request to this URL returns a collection of order + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + * description + * status + * externalId + * processedAt + + The `description` fields can be a pattern and we'll try to match this + phrase. + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getOrderList + parameters: + - name: query[description] + in: query + description: Search order by description + required: false + schema: + type: string + - name: query[status] + in: query + description: Search order by status + required: false + schema: + type: string + - name: query[externalId] + in: query + description: Search order by external ID + required: false + schema: + type: string + - name: query[processedAt][from] + in: query + description: Show orders processed from this date + required: false + schema: + type: string + format: date-time + - name: query[processedAt][to] + in: query + description: Show orders processed to this date + required: false + schema: + type: string + format: date-time + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/OrderList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Orders + summary: Create order + description: >+ + + Sending a **POST** request to this URL will create a new order resource. + + + In order to create a new order, you need to send the order resource in + the body of the request (remember that you need to serialize the body + into a JSON string). + + operationId: createOrder + parameters: + - name: additionalFlags + in: query + description: >- + The additional flags parameter with the value `skipAutomation` will + skip the triggering `Make a purchase` element in an automated + workflow + required: false + schema: + type: string + example: skipAutomation + x-set: + - skipAutomation + requestBody: + $ref: '#/components/requestBodies/NewOrder' + responses: + '201': + $ref: '#/components/responses/OrderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/orders/{orderId}: + get: + tags: + - Orders + summary: Get a single order by ID + description: |+ + + This method returns the order according to the given `orderId`. + + operationId: getOrderById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/OrderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Orders + summary: Update order + description: >+ + + Update the properties of a shop's order. You should send only those + fields that need to be changed. The rest of the properties will stay the + same. + + However, in case of `billingAddress` and `shippingAddress`, you must + send the entire representation. Individual fields can't be updated. + + If you want to update individual fields of an address, you can do so + using `POST /v3/addresses/{addressId}`. + + + In case of `selectedVariants`, when the collection is updated, the old + collection is completely removed. The same goes for meta fields. + + Individual fields can't be updated either. The full representations of + `selectedVariants` and `metaFields` must be sent instead. + + operationId: updateOrder + parameters: + - name: additionalFlags + in: query + description: >- + The additional flags parameter with the value `skipAutomation` will + skip the triggering `Make a purchase` element in an automated + workflow + required: false + schema: + type: string + example: skipAutomation + x-set: + - skipAutomation + requestBody: + $ref: '#/components/requestBodies/UpdateOrder' + responses: + '200': + $ref: '#/components/responses/OrderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Orders + summary: Delete order + description: '' + operationId: deleteOrder + responses: + '204': + description: Delete order + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/orderId' + /shops/{shopId}/products: + get: + tags: + - Products + summary: Get a product list. + description: >- + + Sending a **GET** request to this URL returns a collection of product + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + * name + * vendor + * category + * categoryId + * externalId + * variantName + * metaFieldNames + * metaFieldValues + * createdOn + + The `metaFieldNames` and `metaFieldValues` fields can be a list of + values separated by a comma [,]. + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getProductList + parameters: + - name: query[name] + in: query + description: Search products by name + required: false + schema: + type: string + - name: query[vendor] + in: query + description: Search products by vendor + required: false + schema: + type: string + - name: query[category] + in: query + description: Search products by category name + required: false + schema: + type: string + - name: query[categoryId] + in: query + description: Search products by category ID + required: false + schema: + type: string + - name: query[externalId] + in: query + description: Search products by external ID + required: false + schema: + type: string + - name: query[variantName] + in: query + description: Search products by product variant name + required: false + schema: + type: string + - name: query[metaFieldNames] + in: query + description: >- + Search products by meta field name (the list of names must be + separated by a comma [,]) + required: false + schema: + type: string + - name: query[metaFieldValues] + in: query + description: >- + Search products by meta field value (the list of values must be + separated by a comma [,]) + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search products created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search products created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ProductList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Products + summary: Create product + description: >+ + + Sending a **POST** request to this URL will create a new product + resource. + + + In order to create a new product, you need to send the product resource + in the body of the request (remember that you need to serialize the body + into a JSON string) + + + You don't need a separate endpoint for each element (e.g. variant, + category, meta-field). You can create them all with this method. + + + Please note that categories aren't required, but if a product has at + least one category, then one of those categories must be marked as + default. + + This can be set by field `isDefault`. If none of the elements contains + isDefault=true, then the system picks the first one from the collection + by default. + + operationId: createProduct + requestBody: + $ref: '#/components/requestBodies/NewProduct' + responses: + '201': + $ref: '#/components/responses/ProductDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/products/{productId}: + get: + tags: + - Products + summary: Get a single product by ID + description: >+ + + This method returns product according to the given `productId` in the + context of a given `shopId`. + + operationId: getProductById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ProductDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Products + summary: Update product + description: >+ + + Update the properties of a shop's product. You should only send those + fields that need to be changed. The remaining properties will stay the + same. + + However, when updating variants, categories, and meta fields, you need + to send entire collections. Individual fields can't be updated. + + If you want to update particular fields, you can do so using their + specific endpoints, i.e.: + + * categories - `POST /v3/shops/{shopId}/categories/{categoryId}` + * variants - POST `/v3/shops/{shopId}/products/{productId}/variants/{variantId}` + * metaFields - `POST /v3/shops/{shopId}/meta-fields/{metaFieldId}` + + + operationId: updateProduct + requestBody: + $ref: '#/components/requestBodies/UpdateProduct' + responses: + '200': + $ref: '#/components/responses/ProductDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Products + summary: Delete product + description: '' + operationId: deleteProduct + responses: + '204': + description: Delete product + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + /shops/{shopId}/products/{productId}/categories: + post: + tags: + - Products + summary: Upsert product categories + description: >+ + + This method makes it possible to assign product categories, and to set a + default product category. This method doesn't remove or unassign product + categories. It returns a list of product categories. + + + Please note that if you assign only one category to a given product, + that category is marked as default. If you try to remove the default + mark, your change won't be executed. + + operationId: upsertProductCategories + requestBody: + $ref: '#/components/requestBodies/UpsertProductCategory' + responses: + '200': + $ref: '#/components/responses/SimpleProductCategoryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: upsert + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + /shops/{shopId}/products/{productId}/meta-fields: + post: + tags: + - Products + summary: Upsert product meta fields + description: >+ + + This method makes it possible to assign meta fields. It doesn't remove + or unassign meta fields. It returns a list of product meta fields. + + operationId: upsertMetaFields + requestBody: + $ref: '#/components/requestBodies/UpsertMetaField' + responses: + '200': + $ref: '#/components/responses/MetaFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: upsert + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + /shops/{shopId}: + get: + tags: + - Shops + summary: Get a single shop by ID + description: |+ + + This method returns the shop according to the given `shopId` + + operationId: getShopById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ShopDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Shops + summary: Update shop + description: >+ + + This makes it possible to update shop preferences. You should send only + those fields that need to be changed. The rest of the properties remain + the same. + + operationId: updateShop + requestBody: + $ref: '#/components/requestBodies/UpdateShop' + responses: + '200': + $ref: '#/components/responses/ShopDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Shops + summary: Delete shop + description: |+ + + This method deletes a shop. + + operationId: deleteShop + responses: + '204': + description: Delete a shop + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /popups/{popupId}: + get: + tags: + - Forms and Popups + summary: Get a single form or popup by ID + operationId: getPopupDetails + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/PopupDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/popupId' + /statistics/popups/{popupId}/performance: + get: + tags: + - Form and Popup + summary: Get statistics for a single form or popup + operationId: getPopupGeneralPerformance + parameters: + - name: query[date][from] + in: query + description: Get statistics for a single form or popup from this date + required: false + schema: + type: string + format: date + example: '2023-01-10' + - name: query[date][to] + in: query + description: Get statistics for a single form or popup to this date + required: false + schema: + type: string + format: date + example: '2023-01-20' + - name: query[location] + in: query + description: Form or popup statistics by location + required: false + schema: + type: string + - name: query[device] + in: query + description: Form or popup statistics by device + required: false + schema: + type: string + enum: + - desktop + - mobile + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/PopupGeneralPerformance' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/popupId' + /splittests/{splittestId}: + get: + tags: + - A/B tests + summary: Get a single A/B test. + description: Get a single A/B test by ID. + operationId: getSplittest + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/Splittest' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/splittestId' + /shops/{shopId}/carts: + get: + tags: + - Carts + summary: Get shop carts + description: >- + + Sending a **GET** request to this URL returns a collection of cart + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * externalId + * createdOn + + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getCarts + parameters: + - name: query[createdOn][from] + in: query + description: Search carts created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search carts created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[externalId] + in: query + description: Search cart by external ID + required: false + schema: + type: string + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CartList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Carts + summary: Create cart + description: >+ + + Sending a **POST** request to this URL will create a new cart resource. + + + In order to create a new cart, you need to send the cart resource in the + body of the request (remember that you need to serialize the body into a + JSON string) + + operationId: createCart + requestBody: + $ref: '#/components/requestBodies/NewCart' + responses: + '201': + $ref: '#/components/responses/CartDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/carts/{cartId}: + get: + tags: + - Carts + summary: Get cart by ID + description: >+ + + This method returns cart with the given `cartId` in the context of a + given `shopId` + + operationId: getCart + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CartDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Carts + summary: Update cart + description: >+ + + Update properties of the shop cart. You should send only those fields + that need to be changed. The rest of the properties will stay the same. + + + In case of selectedVariants, when the collection is updated, the old one + is completely removed. + + operationId: updateCart + requestBody: + $ref: '#/components/requestBodies/UpdateCart' + responses: + '200': + $ref: '#/components/responses/CartDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Carts + summary: Delete cart + description: '' + operationId: deleteCart + responses: + '204': + description: Delete cart + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/cartId' + /file-library/files/{fileId}: + get: + tags: + - File Library + summary: Get file by ID + operationId: getFileById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/File' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - File Library + summary: Delete file by file ID + operationId: deleteFile + responses: + '204': + description: Delete file + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/fileId' + /file-library/folders/{folderId}: + delete: + tags: + - File Library + summary: Delete folder by folder ID + operationId: deleteFolder + responses: + '204': + description: Delete folder + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/folderId' + /ab-tests/subject/{abTestId}: + get: + tags: + - A/B tests - subject + summary: Get a single A/B test by ID + operationId: getAbtestsSubjectById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AbtestsSubjectGetDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/abTestId' + /ab-tests/subject/{abTestId}/winner: + post: + tags: + - A/B tests - subject + summary: Choose A/B test winner + operationId: postAbtestsSubjectByIdWinner + requestBody: + $ref: '#/components/requestBodies/ChooseWinnerAbtestsSubject' + responses: + '204': + description: Choose A/B test winner + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/abTestId' + /click-tracks/{clickTrackId}: + get: + tags: + - Click Tracks + summary: Get click tracked link details by click track ID + operationId: getClickTrackById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ClickTrack' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/clickTrackId' + /newsletters/{newsletterId}: + get: + tags: + - Newsletters + summary: Get a single newsletter by its ID. + operationId: getNewsletter + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Newsletters + summary: Delete newsletter + operationId: deleteNewsletter + responses: + '204': + description: Delete newsletter. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/newsletterId' + /newsletters/{newsletterId}/activities: + get: + tags: + - Newsletters + summary: Get newsletter activities + description: >- + By default, activities from the **last 14 days** are listed only. You + can get activities for last 30 days only. You can filter the resource + using criteria specified as `query[*]`. You can provide multiple + criteria, to use AND logic. You can sort the resource using parameters + specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getNewsletterActivities + parameters: + - name: query[activity] + in: query + description: Search newsletter activities by activity type + required: false + schema: + type: string + enum: + - send + - open + - click + - name: query[createdOn][from] + in: query + description: >- + Search newsletter activities from this date. Default value is 14 + days earlier. You can get activities for last 30 days only. + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search newsletter activities to this date. Default value is now + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/NewsletterActivities' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/newsletterId' + /newsletters/{newsletterId}/cancel: + post: + tags: + - Newsletters + summary: Cancel sending the newsletter + description: > + > + + Using this method, you can cancel the sending of the newsletter. It will + also turn the newsletter into a **draft**. + operationId: cancelMessageSend + responses: + '200': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: CancelNewsletter + x-no-body: true + parameters: + - $ref: '#/components/parameters/newsletterId' + /newsletters/{newsletterId}/thumbnail: + get: + tags: + - Newsletters + summary: Get newsletter thumbnail + operationId: getNewsletterThumbnail + parameters: + - name: size + in: query + description: The size of the thumbnail + required: false + schema: + type: string + default: default + enum: + - default + - small + responses: + '200': + description: The newsletter thumbnail. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + image/*: + schema: + type: string + format: binary + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: get + x-operation-class-name: GetNewsletterThumbnail + parameters: + - $ref: '#/components/parameters/newsletterId' + /newsletters/{newsletterId}/statistics: + get: + tags: + - Newsletters + summary: The statistics of single newsletter + description: >- + > + + This makes it possible to easily fetch statistics for a single + newsletter. You can group the data hourly, daily, monthly and as a + + total sum. Remember that all statistics date ranges are given in + standard UTC period type objects. + + ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)). + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getSingleNewsletterStatistics + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SingleMessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetNewsletterStatistics + parameters: + - $ref: '#/components/parameters/newsletterId' + /tags/{tagId}: + get: + tags: + - Tags + summary: Get tag by ID + operationId: getTagById + parameters: + - name: tagId + in: path + description: The tag ID + required: true + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TagDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Tags + summary: Update tag by ID + operationId: updateTag + requestBody: + $ref: '#/components/requestBodies/UpdateTag' + responses: + '200': + $ref: '#/components/responses/TagDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Tags + summary: Delete tag by ID + operationId: deleteTag + responses: + '204': + description: Tag deleted successfully. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/tagId' + /addresses/{addressId}: + get: + tags: + - Addresses + summary: Get an address by ID + description: '' + operationId: getAddress + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AddressDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Addresses + summary: Update address + description: > + + Update an existing address. You should send only those fields that need + to be changed. The rest of the properties will stay the same. + operationId: updateAddress + requestBody: + $ref: '#/components/requestBodies/UpdateAddress' + responses: + '200': + $ref: '#/components/responses/AddressDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Addresses + summary: Delete address + description: '' + operationId: deleteAddress + responses: + '204': + description: Empty response + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/addressId' + /campaigns/{campaignId}/blocklists: + get: + tags: + - Campaigns (Lists) + summary: Returns campaign blocklist masks + operationId: getCampaignBlocklist + parameters: + - name: query[mask] + in: query + description: Blocklist mask to search for + required: false + schema: + type: string + example: '@somedomain.com' + responses: + '200': + $ref: '#/components/responses/CampaignBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Campaigns (Lists) + summary: Updates campaign blocklist masks + operationId: updateCampaignBlocklist + parameters: + - name: additionalFlags + in: query + description: >- + The flag value `add` adds the masks provided in the request body to + your blocklist. The flag value `delete` deletes the masks. The masks + are replaced if there are no flag values in the request body. + + For better performance, use the flag value `noResponse`. It removes the response body and can be used alone or combined with other flags. If multiple flags are used, separate them by a comma, like this: `additionalFlags=noResponse` or `additionalFlags=add,noResponse`. + required: false + schema: + type: string + enum: + - add + - delete + - noResponse + requestBody: + $ref: '#/components/requestBodies/UpdateCampaignBlocklist' + responses: + '200': + $ref: '#/components/responses/CampaignBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: update + parameters: + - $ref: '#/components/parameters/campaignId' + /custom-fields/{customFieldId}: + get: + tags: + - Custom Fields + summary: Get a single custom field definition by the custom field ID + operationId: getCustomFieldById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CustomFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Custom Fields + summary: Update the custom field definition + operationId: updateCustomField + requestBody: + $ref: '#/components/requestBodies/UpdateCustomField' + responses: + '200': + $ref: '#/components/responses/CustomFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Custom Fields + summary: Delete a single custom field definition + operationId: deleteCustomField + responses: + '204': + description: Delete a custom field. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/customFieldId' + /lps/{lpsId}: + get: + tags: + - Landing Pages + summary: Get a single landing page by ID + operationId: getLpsById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LpsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/lpsId' + /statistics/lps/{lpsId}/performance: + get: + tags: + - Landing Page + summary: Get details for landing page statistics + operationId: getLpsGeneralPerformanceStats + parameters: + - name: query[date][from] + in: query + description: Show a single landing page statistics from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[date][to] + in: query + description: Show a single landing page statistics to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[location] + in: query + description: Landing page statistics by location + required: false + schema: + type: string + - name: query[device] + in: query + description: Landing page statistics by device + required: false + schema: + type: string + enum: + - desktop + - mobile + - name: query[page] + in: query + description: Landing page statistics by page UUID + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LpsStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/lpsId' + /shops/{shopId}/products/{productId}/variants: + get: + tags: + - Product Variants + summary: Get a list of product variants + description: >+ + + Sending a **GET** request to this URL returns a collection of product + variant resources that belong to the given shop and product. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + + * sku + + * description + + + The `description` fields can be a pattern and we'll try to match this + phrase. + + operationId: getProductVariantList + parameters: + - name: query[name] + in: query + description: Search variant by name + required: false + schema: + type: string + - name: query[sku] + in: query + description: Search variant by SKU + required: false + schema: + type: string + - name: query[description] + in: query + description: Search variant by description + required: false + schema: + type: string + - name: query[externalId] + in: query + description: Search variant by external ID + required: false + schema: + type: string + - name: query[createdAt][from] + in: query + description: Show variants starting from this date + required: false + schema: + type: string + format: date-time + - name: query[createdAt][to] + in: query + description: Show variants starting to this date + required: false + schema: + type: string + format: date-time + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ProductVariantList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Product Variants + summary: Create product variant + description: >+ + + Sending a **POST** request to this URL will create a new product variant + resource. + + + In order to create a new product variant, you need to send a product + variant resource in the body of the request (remember that you need to + serialize the body into a JSON string) + + + There is no need to create every element (like: image, meta field, tax) + one by one by their own endpoints. All these elements can be created + during this method. + + operationId: createProductVariant + requestBody: + $ref: '#/components/requestBodies/NewProductVariant' + responses: + '201': + $ref: '#/components/responses/ProductVariantDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + /shops/{shopId}/products/{productId}/variants/{variantId}: + get: + tags: + - Product Variants + summary: Get a single product variant by ID + description: >+ + + This method returns product variant according to the given `variantId` + in the context of a given `shopId` and `productId` + + operationId: getProductVariantById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ProductVariantDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Product Variants + summary: Update product variant + description: >+ + + Update properties of a product variant. You should send only those + fields that need to be changed. The remaining properties will stay the + same. However, when updating metafields, images, and taxes, you need to + send entire collections. Individual fields can't be updated. If you want + to update particular metafields or tax resources, you can do so using + their particular endpoints, i.e: + + * taxes - `POST /v3/shops/{shopId}/taxes/{taxId}` + * metaFields - `POST /v3/shops/{shopId}/meta-fields/{metaFieldId}` + + operationId: updateProductVariant + requestBody: + $ref: '#/components/requestBodies/UpdateProductVariant' + responses: + '200': + $ref: '#/components/responses/ProductVariantDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Product Variants + summary: Delete product variant + description: '' + operationId: deleteProductVariant + responses: + '204': + description: Delete product variant + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + - $ref: '#/components/parameters/variantId' + /campaigns/{campaignId}: + get: + tags: + - Campaigns (Lists) + summary: Get a single campaign by the campaign ID + operationId: getCampaign + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/Campaign' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Campaigns (Lists) + summary: Update a campaign + operationId: updateCampaign + requestBody: + $ref: '#/components/requestBodies/UpdateCampaign' + responses: + '200': + $ref: '#/components/responses/Campaign' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/campaignId' + /shops/{shopId}/meta-fields: + get: + tags: + - Meta Fields + summary: Get the shop meta fields + description: >- + + Sending a **GET** request to this URL returns a collection of meta field + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + * value + * description + * createdOn + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getMetaFields + parameters: + - name: query[name] + in: query + description: Search meta fields by name + required: false + schema: + type: string + - name: query[description] + in: query + description: Search meta fields by description + required: false + schema: + type: string + - name: query[value] + in: query + description: Search meta fields by value + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search meta fields created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search meta fields created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MetaFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Meta Fields + summary: Create meta field + description: > + + Sending a **POST** request to this URL will create a new meta field + resource. + + + In order to create a new meta field, you need to send a meta field + resource in the body of the request (remember that you need to serialize + the body into a JSON string) + operationId: createMetaField + requestBody: + $ref: '#/components/requestBodies/NewMetaField' + responses: + '201': + $ref: '#/components/responses/MetaFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/meta-fields/{metaFieldId}: + get: + tags: + - Meta Fields + summary: Get the meta field by ID + description: > + + This method returns meta field with a given `metaFieldId` in the context + of a given `shopId` + operationId: getMetaField + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/MetaFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Meta Fields + summary: Update meta field + description: > + + Update the properties of a shop's meta field. You should send only those + fields that need to be changed. The rest of the properties will stay the + same. + operationId: updateMetaField + requestBody: + $ref: '#/components/requestBodies/UpdateMetaField' + responses: + '200': + $ref: '#/components/responses/MetaFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Meta Fields + summary: Delete meta field + description: '' + operationId: deleteMetaField + responses: + '204': + description: Delete meta field + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/metaFieldId' + /webforms/{webformId}: + get: + tags: + - Legacy Forms + summary: Get Legacy Form by ID. + description: Get Legacy Form by ID. + operationId: getLegacyFormById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LegacyForm' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/webformId' + /gdpr-fields/{gdprFieldId}: + get: + tags: + - GDPR Fields + summary: Get GDPR Field details + operationId: getGDPRField + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/GDPRFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/gdprFieldId' + /workflow/{workflowId}: + get: + tags: + - Workflows + summary: Get workflow by ID + description: Get a single workflow by ID. + operationId: getWorkflow + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/Workflow' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Workflows + summary: Update workflow + description: Update single workflow. + operationId: updateWorkflow + requestBody: + $ref: '#/components/requestBodies/UpdateWorkflow' + responses: + '200': + $ref: '#/components/responses/Workflow' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/workflowId' + /sms/{smsId}: + get: + tags: + - SMS Messages + summary: Get a single SMS message by its ID + operationId: getSmsById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SmsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + parameters: + - $ref: '#/components/parameters/smsId' + /autoresponders/{autoresponderId}: + get: + tags: + - Autoresponders + summary: Get a single autoresponder by its ID + operationId: getAutoresponder + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AutoresponderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Autoresponders + summary: Update autoresponder + description: > + > + + **The action-based autoresponder feature has been migrated over to + marketing automation. Your existing autoresponders are + + now converted into workflows. You can no longer create and update + action-based autoresponders using our API.** + + + This method allows you to update an autoresponder. The same rules as in + creating an autoresponder apply. + operationId: updateAutoresponder + requestBody: + $ref: '#/components/requestBodies/UpdateAutoresponder' + responses: + '200': + $ref: '#/components/responses/AutoresponderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Autoresponders + summary: Delete autoresponder. + operationId: deleteAutoresponder + responses: + '204': + description: Delete autoresponder + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/autoresponderId' + /autoresponders/{autoresponderId}/thumbnail: + get: + tags: + - Autoresponders + summary: Get the autoresponder thumbnail + operationId: getAutoresponderThumbnail + parameters: + - name: size + in: query + description: The size of the autoresponder thumbnail + required: false + schema: + type: string + default: default + enum: + - default + - small + responses: + '200': + description: The autoresponder thumbnail. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + image/*: + schema: + type: string + format: binary + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: get + x-operation-class-name: GetAutoresponderThumbnail + parameters: + - $ref: '#/components/parameters/autoresponderId' + /autoresponders/{autoresponderId}/statistics: + get: + tags: + - Autoresponders + summary: The statistics for a single autoresponder + description: >- + > + + This requst returns the statistics summary for a single given + autoresponder. As in all statistics, you can change the date and time + range (hourly daily monthly or total). Keep in mind + + that all statistics date ranges are given in standard UTC period type + objects. ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)) + + + (https://app.getresponse.com/statistics.html?t=followup#total). + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getSingleAutoresponderStatistics + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SingleMessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetAutoresponderStatistics + parameters: + - $ref: '#/components/parameters/autoresponderId' + /websites/{websiteId}: + get: + tags: + - Websites + summary: Get a single Website by ID + operationId: getWebsiteById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/WebsiteDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/websiteId' + /statistics/wbe/{websiteId}/performance: + get: + tags: + - Website + summary: Get details for website statistics + operationId: getWbeGeneralPerformanceStats + parameters: + - name: query[date][from] + in: query + description: Show a single website statistics from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[date][to] + in: query + description: Show a single website statistics to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[location] + in: query + description: Website statistics by location + required: false + schema: + type: string + - name: query[device] + in: query + description: Website statistics by device + required: false + schema: + type: string + enum: + - desktop + - mobile + - name: query[page] + in: query + description: Website statistics by a page UUID + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/WebsiteStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/websiteId' + /webinars: + get: + tags: + - Webinars + summary: Get a list of webinars + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getWebinarList + parameters: + - name: query[name] + in: query + description: Search webinars by name + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: The list of campaign resource IDs (string separated with ',') + required: false + schema: + type: string + - name: query[status] + in: query + description: Search webinars by status + required: false + schema: + type: string + enum: + - upcoming + - finished + - published + - unpublished + - name: sort[name] + in: query + description: Sort webinars by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort webinars by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[startsOn] + in: query + description: Sort webinars by update date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: query[type] + in: query + description: Search webinars by type + required: false + schema: + type: string + enum: + - all + - live + - on_demand + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/WebinarList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /contacts: + get: + tags: + - Contacts + summary: Get contact list + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getContactList + parameters: + - name: query[email] + in: query + description: Search contacts by email + required: false + schema: + type: string + - name: query[name] + in: query + description: Search contacts by name + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: Search contacts by campaign ID + required: false + schema: + type: string + - name: query[origin] + in: query + description: Search contacts by origin + required: false + schema: + type: string + enum: + - import + - email + - www + - panel + - leads + - sale + - api + - forward + - survey + - iphone + - copy + - landing_page + - webinar + - website_builder_elegant + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[changedOn][from] + in: query + description: Search contacts edited from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[changedOn][to] + in: query + description: Search contacts edited to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[email] + in: query + description: Sort by email + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[changedOn] + in: query + description: Sort by change date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[campaignId] + in: query + description: Sort by campaign ID + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: additionalFlags + in: query + description: >- + The additional flags parameter with the value 'exactMatch' will + search for contacts with the exact value of the email and name + provided in the query string. Without this flag, matching is done + via a standard 'like' comparison, which may sometimes be slow. + required: false + schema: + type: string + x-set: + - exactMatch + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ContactList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Contacts + summary: Create a new contact + operationId: createContact + requestBody: + $ref: '#/components/requestBodies/NewContact' + responses: + '202': + description: >- + > + + If the request is successful, the API returns the HTTP code **202 + Accepted**. + + This means that the contact has been preliminarily validated and + added to the queue. + + It may take a few minutes to process the queue and add the contact + to the list. If your contact didn't appear on the list, there's a + possibility that it was rejected at a later stage of processing. + + + ### Double opt-in + + + Campaigns can be set to double opt-in. + + This means that the contact has to click a link in a confirmation + message before they can be added to your list. + + Unconfirmed contacts are not returned by the API and can only be + found using Search Contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /contacts/batch: + post: + tags: + - Contacts + summary: Create multiple contacts at once + description: >- + This endpoint lets you create multiple contacts in one request. + + + **Note** + + + This endpoint is subject to special limits and throttling. You can make + 80 calls per time frame (10 minutes). The allowed batch size is 1000 + contacts. For more information, check our [API + Docs](https://apidocs.getresponse.com/v3/case-study/adding-batch-contacts). + operationId: createBatchContacts + requestBody: + content: + application/json: + schema: + required: + - campaignId + - contacts + properties: + campaignId: + description: ID of the destination campaign (list). + type: string + example: C + contacts: + description: Contacts that will be created. + type: array + items: + required: + - email + properties: + email: + type: string + format: email + example: john.doe@example.com + name: + type: string + maxLength: 128 + minLength: 1 + example: John Doe + dayOfCycle: + description: The day a contact is on in an autoresponder cycle. + type: string + example: '42' + scoring: + description: Contact's score + type: number + example: 8 + ipAddress: + description: >- + Contact's IP address. IPv4 and IPv6 formats are + accepted. + example: 1.2.3.4 + oneOf: + - type: string + format: ipv4 + - type: string + format: ipv6 + tags: + required: + - ids + properties: + ids: + description: List of tag IDs. + type: array + items: + type: string + example: kL6Nh + type: object + customFieldValues: + type: array + items: + required: + - customFieldId + - value + properties: + customFieldId: + description: Custom field ID. + type: string + example: kL6Nh + value: + type: array + items: + type: string + example: 18-35 + type: object + type: object + type: object + responses: + '202': + description: >- + > + + If the request is successful, the API returns the HTTP code **202 + Accepted**. + + This means that the contacts has been preliminarily validated and + added to the queue. + + It may take a few minutes to process the queue and add the contacts + to the list. If your contact doesn't appear on the list, they were + likely rejected during the late processing stages. + + + ### Double opt-in + + + Campaigns (lists) can be set to use double opt-in. + + This means that a contact has to click a link in a confirmation + message before they can be added to your list. + + Unconfirmed contacts are not returned by API and can only be found + using Search Contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /search-contacts: + get: + tags: + - Search Contacts + summary: Get a saved search contact list + description: >- + Makes it possible to retrieve a collection of short representations of + search-contact (known as custom filters in the panel). Every item + represents a basic filter object. You can filter the resource using + criteria specified as `query[*]`. You can provide multiple criteria, to + use AND logic. You can sort the resource using parameters specified as + `sort[*]`. You can specify multiple fields to sort by. + operationId: getSearchContactsList + parameters: + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - name: sort[createdOn] + in: query + description: Sort by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: asc + - name: query[name] + in: query + description: Search by name + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/BaseSearchContactsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Search Contacts + summary: Create search contacts + description: >- + Makes it possible to create a new search-contact. Please refer to + [Segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual) + operationId: newSearchContacts + requestBody: + $ref: '#/components/requestBodies/NewSearchContacts' + responses: + '201': + $ref: '#/components/responses/SearchContactsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /search-contacts/contacts: + post: + tags: + - Search Contacts + summary: Search contacts using conditions + description: >- + Makes it possible to get a collection of contacts according to a given + condition. Please refer to [Segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual) + operationId: getContactsFromSearchContactsConditions + parameters: + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - name: sort[email] + in: query + description: Sort by email + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - name: sort[createdOn] + in: query + description: Sort by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: asc + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + requestBody: + $ref: '#/components/requestBodies/SearchContactsConditionsDetails' + responses: + '200': + $ref: '#/components/responses/SearchedContactsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetContactsBySearchContactsConditions + /transactional-emails/templates: + get: + tags: + - Transactional Emails Templates + summary: Get the list of transactional email templates + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getTransactionalEmailsTemplatesList + parameters: + - name: query[subject] + in: query + description: Search templates by subject + required: false + schema: + type: string + - name: sort[createdOn] + in: query + description: Sort by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subject] + in: query + description: Sort by template subject + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailsTemplateList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + post: + tags: + - Transactional Emails Templates + summary: Create transactional email template + description: This method creates a new transactional email template + operationId: createTransactionalEmailTemplate + requestBody: + $ref: '#/components/requestBodies/CreateTransactionalEmailTemplate' + responses: + '201': + $ref: '#/components/responses/TransactionalEmailsTemplateDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /transactional-emails: + get: + tags: + - Transactional Emails + summary: Get the list of transactional emails + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getTransactionalEmailsList + parameters: + - name: query[sentOn][from] + in: query + description: Search transactional emails sent from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[sentOn][to] + in: query + description: Search transactional emails sent to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[tagged] + in: query + description: Search tagged/untagged transactional emails + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - name: query[tagId] + in: query + description: Search transactional emails with a specific tag ID + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + post: + tags: + - Transactional Emails + summary: Send transactional email + operationId: createTransactionalEmail + requestBody: + $ref: '#/components/requestBodies/CreateTransactionalEmail' + responses: + '201': + $ref: '#/components/responses/TransactionalEmail' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /transactional-emails/statistics: + get: + tags: + - Transactional Emails + summary: Get the overall statistics of transactional emails + operationId: getTransactionalEmailsStatistics + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: true + schema: + type: string + enum: + - total + - day + - name: query[timeFrame][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[timeFrame][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[tagged] + in: query + description: Search tagged/untagged transactional emails + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - name: query[tagId] + in: query + description: Search transactional emails with a specific tag ID + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailStatistics' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /from-fields: + get: + tags: + - From Fields + summary: Get the list of 'From' addresses + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getFromFieldList + parameters: + - name: query[email] + in: query + description: Search 'From' address by email + required: false + schema: + type: string + - name: query[name] + in: query + description: Search 'From' address by name + required: false + schema: + type: string + format: date + - name: query[isDefault] + in: query + description: Search only default 'From' address + required: false + schema: + type: boolean + example: true + - name: query[isActive] + in: query + description: Search only active 'From' addresses + required: false + schema: + type: boolean + example: true + - name: sort[createdOn] + in: query + description: Sort 'From' address by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FromFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - From Fields + summary: Create 'From' address + operationId: createFromField + requestBody: + $ref: '#/components/requestBodies/NewFromField' + responses: + '201': + $ref: '#/components/responses/FromFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /rss-newsletters: + get: + tags: + - RSS Newsletters + summary: Get the list of RSS newsletters + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getRssNewslettersList + parameters: + - name: query[subject] + in: query + description: Search RSS newsletters by subject + required: false + schema: + type: string + - name: query[status] + in: query + description: Search RSS newsletters by status + required: false + schema: + type: string + enum: + - enabled + - disabled + - name: query[createdOn][from] + in: query + description: Search RSS newsletters created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search RSS newsletters created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[campaignId] + in: query + description: Search RSS newsletters by campaign ID + required: false + schema: + type: string + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/RssNewsletterList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - RSS Newsletters + summary: Create RSS newsletter + operationId: createRssNewsletter + requestBody: + $ref: '#/components/requestBodies/NewRssNewsletter' + responses: + '201': + $ref: '#/components/responses/RssNewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /rss-newsletters/statistics: + get: + tags: + - RSS Newsletters + summary: The statistics for all RSS newsletters + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getRssNewsletterStatisticsCollection + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[rssNewsletterId] + in: query + description: The list of RSS newsletter resource IDs (string separated with ',') + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: The list of campaign resource IDs (string separated with ',') + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetRssNewslettersStatistics + /custom-events: + get: + tags: + - Custom Events + summary: Get a list of custom events + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getCustomEventsList + parameters: + - name: query[name] + in: query + description: Search custom events by name + required: false + schema: + type: string + - name: query[hasAttributes] + in: query + description: Search custom events with or without attributes + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CustomEventsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Custom Events + summary: Create custom event + operationId: createCustomEvent + requestBody: + $ref: '#/components/requestBodies/NewCustomEvent' + responses: + '201': + $ref: '#/components/responses/CustomEventDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /custom-events/trigger: + post: + tags: + - Custom Events + summary: Trigger a custom event + operationId: triggerCustomEvent + requestBody: + $ref: '#/components/requestBodies/TriggerCustomEvent' + responses: + '201': + description: Empty response + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: TriggerCustomEvent + /forms: + get: + tags: + - Forms + summary: Get the list of forms. + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getFormList + parameters: + - name: query[name] + in: query + description: Search forms by name + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search forms created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search forms created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[campaignId] + in: query + description: >- + Search forms assigned to this list (campaign). You can pass multiple + comma-separated values, eg. `Xd1P,sC7r` + required: false + schema: + type: string + - name: query[status] + in: query + description: >- + Search by status. **Note:** `disabled` includes both `unpublished` + and `draft` and `enabled` equals `published` + required: false + schema: + type: string + enum: + - enabled + - disabled + - published + - unpublished + - draft + - name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[visitors] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[uniqueVisitors] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subscribed] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subscriptionRate] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FormList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /landing-pages: + get: + tags: + - Legacy Landing Pages + summary: Get a list of landing pages + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getLandingPageList + parameters: + - name: query[domain] + in: query + description: Search landing pages by domain + required: false + schema: + type: string + - name: query[status] + in: query + description: Search landing pages by status + required: false + schema: + $ref: '#/components/schemas/StatusEnum' + - name: query[subdomain] + in: query + description: Search landing pages by subdomain + required: false + schema: + type: string + - name: query[metaTitle] + in: query + description: Search landing pages by metaTitle field + required: false + schema: + type: string + - name: query[userDomain] + in: query + description: Search landing pages by user provided domain + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: >- + Search landing pages by ID of the assigned campaign. Campaign ID + must be encoded! You can get the campaign list with encoded IDs by + calling the `/v3/campaigns` endpoint. You can search by multiple + comma separated values eg. `o5lx,34er`. + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Show landing pages created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Show landing pages created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[domain] + in: query + description: Sort by domain + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[campaignId] + in: query + description: Sort by campaign + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[metaTitle] + in: query + description: Sort by metaTitle + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/LandingPageList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /imports: + get: + tags: + - Imports + summary: Get a list of imports. + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getImportList + parameters: + - name: query[campaignId] + in: query + description: Search imports by campaignId + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search imports created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search imports created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort imports by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[finishedOn] + in: query + description: Sort imports by finish date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[campaignName] + in: query + description: Sort imports by campaign name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[uploadedContacts] + in: query + description: Sort imports by uploaded contact count + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[updatedContacts] + in: query + description: Sort imports by updated contact count + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[addedContacts] + in: query + description: Sort imports by inserted contact count + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[invalidContacts] + in: query + description: Sort imports by invalid contact count + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[status] + in: query + description: >- + Sort imports by status (uploaded, to_review, approved, finished, + rejected, canceled) + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ImportList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Imports + summary: Schedule a new contact import + description: >- + This endpoint lets you schedule a contact import. That way, you can add + and update your contacts using a single API call. Since API imports are + asynchronous, you should check periodically for updates while your + original API request is being processed. To keep track of your import + status, use [GET + import](https://apireference.getresponse.com/#operation/getImportById) + (provide the importId from the response), or subscribe to an [import + finished](https://apidocs.getresponse.com/v3/payloads#contacts-import-finished) + webhook. For more information on imports, check our [API + Docs](https://apidocs.getresponse.com/v3/case-study/create-import) or + [Help + Center](https://www.getresponse.com/help/how-do-i-prepare-a-file-for-import.html) + operationId: createImport + requestBody: + $ref: '#/components/requestBodies/NewImport' + responses: + '201': + $ref: '#/components/responses/ImportDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /statistics/ecommerce/revenue: + get: + tags: + - Ecommerce + summary: Get the ecommerce revenue statistics + operationId: getRevenueStats + parameters: + - name: query[orderDate][from] + in: query + description: Show statistics for orders from this date + required: false + schema: + type: string + format: date + - name: query[orderDate][to] + in: query + description: Show statistics for orders to this date + required: false + schema: + type: string + format: date + - name: query[shopId] + in: query + description: >- + Search statistics by shop ID. You can get the shop ID by calling the + `/v3/shops` endpoint. You can search for multiple shops using + comma-separated values, for example, `pgIH, CNXF` + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/RevenueStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /statistics/ecommerce/performance: + get: + tags: + - Ecommerce + summary: Get the ecommerce general performance statistics + operationId: getGeneralPerformanceStats + parameters: + - name: query[orderDate][from] + in: query + description: Show statistics for orders from this date + required: false + schema: + type: string + format: date + - name: query[orderDate][to] + in: query + description: Show statistics for orders to this date + required: false + schema: + type: string + format: date + - name: query[shopId] + in: query + description: >- + Search statistics by shop ID. You can get the shop ID by calling the + `/v3/shops` endpoint. You can search for multiple shops using + comma-separated values, for example, `pgIH, CNXF` + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/GeneralPerformanceStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /predefined-fields: + get: + tags: + - Predefined Fields + summary: Get the predefined fields list + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getPredefinedFieldList + parameters: + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: DESC + - name: query[name] + in: query + description: Search by name + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: Search by campaign ID + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/PredefinedFieldsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Predefined Fields + summary: Create a predefined field + description: Makes it possible to create a new predefined field. + operationId: createPredefinedField + requestBody: + $ref: '#/components/requestBodies/NewPredefinedField' + responses: + '201': + $ref: '#/components/responses/PredefinedFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /suppressions: + get: + tags: + - Suppressions + summary: Get suppression lists + operationId: getSuppressionsList + parameters: + - name: query[name] + in: query + description: Search suppressions by name + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search suppressions created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search suppressions created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by the createdOn date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SuppressionsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Suppressions + summary: Creates a new suppression list + operationId: createSuppression + requestBody: + description: The suppression list to be added. + $ref: '#/components/requestBodies/NewSuppression' + responses: + '201': + $ref: '#/components/responses/SuppressionDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /subscription-confirmations/body/{languageCode}: + get: + tags: + - Subscription Confirmations + summary: Get collection of SUBSCRIPTION CONFIRMATIONS bodies + description: >+ + + Sending **GET** request to this url, returns collection of + **SUBSCRIPTION CONFIRMATIONS** bodies. + + + Language code used in url must be in ISO 639-1 Language Code Standard. + + operationId: getSubscriptionConfirmationBodyList + parameters: + - $ref: '#/components/parameters/languageCode' + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SubscriptionConfirmationBodyList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /subscription-confirmations/subject/{languageCode}: + get: + tags: + - Subscription Confirmations + summary: Get collection of SUBSCRIPTION CONFIRMATIONS subjects + description: >+ + + Sending **GET** request to this url, returns collection of + **SUBSCRIPTION CONFIRMATIONS** subjects. + + + Language code used in url must be in ISO 639-1 Language Code Standard. + + operationId: getSubscriptionConfirmationSubjectList + parameters: + - $ref: '#/components/parameters/languageCode' + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SubscriptionConfirmationSubjectList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /shops: + get: + tags: + - Shops + summary: Get a list of shops + description: >- + + Sending a **GET** request to this URL returns a collection of shop + resources. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + + The `name` fields can be a pattern and we'll try to match this phrase. + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getShopList + parameters: + - name: query[name] + in: query + description: Search shop by name + required: false + schema: + type: string + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ShopList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Shops + summary: Create shop + description: |+ + + This method makes it possible to create a new shop. + + operationId: createShop + requestBody: + $ref: '#/components/requestBodies/NewShop' + responses: + '201': + $ref: '#/components/responses/ShopDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /popups: + get: + tags: + - Forms and Popups + summary: Get the list of forms and popups + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getPopupsList + parameters: + - name: query[name] + in: query + description: Search forms and popups by name + required: false + schema: + type: string + - name: query[status] + in: query + description: Search forms and popups by status + required: false + schema: + type: string + enum: + - published + - unpublished + - name: stats[from] + in: query + description: Show statistics from this date + required: false + schema: + type: string + format: date-time + - name: stats[to] + in: query + description: Show statistics to this date + required: false + schema: + type: string + format: date-time + - name: sort[name] + in: query + description: Sort forms and popups by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[status] + in: query + description: Sort forms and popups by status + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdAt] + in: query + description: Sort forms and popups by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[updatedAt] + in: query + description: Sort forms and popups by modification date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[views] + in: query + description: Sort by number of views + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[uniqueVisitors] + in: query + description: Sort by number of unique visitors + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[leads] + in: query + description: Sort by number of leads + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[ctr] + in: query + description: Sort by CTR (click-through rate) + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/PopupsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /splittests: + get: + tags: + - A/B tests + summary: The list of A/B tests. + description: >- + The list of A/B tests. You can filter the resource using criteria + specified as `query[*]`. You can provide multiple criteria, to use AND + logic. You can sort the resource using parameters specified as + `sort[*]`. You can specify multiple fields to sort by. + operationId: getSplittestList + parameters: + - name: query[name] + in: query + description: Search A/B tests by name + required: false + schema: + type: string + - name: query[type] + in: query + description: Search A/B tests by type + required: false + schema: + type: string + - name: query[status] + in: query + description: Search A/B tests by status + required: false + schema: + type: string + default: active + enum: + - active + - inactive + - name: query[createdOn][from] + in: query + description: Search A/B tests created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search A/B tests created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SplittestList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /file-library/quota: + get: + tags: + - File Library + summary: Get storage space information + operationId: quota + responses: + '200': + $ref: '#/components/responses/Quota' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /file-library/files: + get: + tags: + - File Library + summary: Get the list of files + description: >- + By default, you can only search files in the root directory. To search + for files in all folders, use the parameter `query[allFolders]=true`. To + search for files in a specified folder, use the parameter + `query[folderId]=`. **Note: these two parameters can't be used + together**. You can filter the resource using criteria specified as + `query[*]`. You can provide multiple criteria, to use AND logic. You can + sort the resource using parameters specified as `sort[*]`. You can + specify multiple fields to sort by. + operationId: getFileList + parameters: + - name: query[allFolders] + in: query + description: >- + Return files from all folders, including the root folder. **This + parameter can't be used together with ** `query[folderId]` + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - name: query[folderId] + in: query + description: >- + Search for files in a specific folder. **This parameter can't be + used together with ** `query[allFolders]` + required: false + schema: + type: string + - name: query[name] + in: query + description: Search for files by name + required: false + schema: + type: string + - name: query[group] + in: query + description: Search for files by group + required: false + schema: + $ref: '#/components/schemas/FileGroup' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[group] + in: query + description: Sort files by group + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[size] + in: query + description: Sort files by size + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FileList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - File Library + summary: Create a file + operationId: createFile + requestBody: + $ref: '#/components/requestBodies/NewFile' + responses: + '201': + $ref: '#/components/responses/File' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /file-library/folders: + get: + tags: + - File Library + summary: Get the list of folders + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getFolderList + parameters: + - name: query[name] + in: query + description: Search folders by name + required: false + schema: + type: string + - name: sort[name] + in: query + description: Sort folders by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[size] + in: query + description: Sort folders by size + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort folders by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FoldersList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - File Library + summary: Create a folder + operationId: createFolder + requestBody: + $ref: '#/components/requestBodies/NewFolder' + responses: + '201': + $ref: '#/components/responses/Folder' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /ab-tests/subject: + get: + tags: + - A/B tests - subject + summary: The list of A/B tests + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: AbtestsSubjectGetList + parameters: + - name: query[name] + in: query + description: Search A/B tests by name + required: false + schema: + type: string + - name: query[stage] + in: query + description: Search A/B tests by stage + required: false + schema: + type: string + enum: + - preparing + - testing + - finished + - sending-winner + - cancelled + - draft + - completed + - name: query[abTestId] + in: query + description: Search A/B tests by ID + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: Search A/B tests by list ID + required: false + schema: + type: string + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[stage] + in: query + description: Sort by stage + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[sendOn] + in: query + description: Sort by send date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[totalDelivered] + in: query + description: Sort by total delivered + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AbtestsSubjectGetList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - A/B tests - subject + summary: Create a new A/B test + operationId: postAbtestsSubjectById + requestBody: + $ref: '#/components/requestBodies/NewAbtestsSubject' + responses: + '201': + $ref: '#/components/responses/AbtestsSubjectGetDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /click-tracks: + get: + tags: + - Click Tracks + summary: Get click tracked links list + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getClickTrackList + parameters: + - name: query[createdOn][from] + in: query + description: Search click tracks from messages created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search click tracks from messages created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort by message date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ClickTrackList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /newsletters: + get: + tags: + - Newsletters + summary: Get the newsletter list + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getNewsletterList + parameters: + - name: query[subject] + in: query + description: Search newsletters by subject + required: false + schema: + type: string + - name: query[name] + in: query + description: Search newsletters by name + required: false + schema: + type: string + - name: query[status] + in: query + description: Search newsletters by status + required: false + schema: + type: string + enum: + - enabled + - disabled + - name: query[createdOn][from] + in: query + description: Search newsletters created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search newsletters created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[sendOn][from] + in: query + description: Search for newsletters sent from this date + required: false + schema: + type: string + format: date + example: '2023-01-20' + - name: query[sendOn][to] + in: query + description: Search for newsletters sent to this date + required: false + schema: + type: string + format: date + example: '2023-01-20' + - name: query[type] + in: query + description: Search newsletters by type + required: false + schema: + type: string + enum: + - draft + - broadcast + - splittest + - automation + - name: query[campaignId] + in: query + description: Search newsletters by campaign ID + required: false + schema: + type: string + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[sendOn] + in: query + description: Sort by send on date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/NewsletterList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Newsletters + summary: Create newsletter + description: | + > + This method creates a new newsletter and puts it in a queue to send. + + **NOTE: This method has a limit of 256 calls per day.** + operationId: createNewsletter + requestBody: + $ref: '#/components/requestBodies/NewNewsletter' + responses: + '201': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /newsletters/send-draft: + post: + tags: + - Newsletters + summary: Send the newsletter draft + operationId: sendDraft + requestBody: + $ref: '#/components/requestBodies/SendNewsletterDraft' + responses: + '201': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: SendNewsletterDraft + /newsletters/statistics: + get: + tags: + - Newsletters + summary: Total newsletter statistics + description: >- + >This makes it possible to fetch newsletter statistics based on the list + of campaign or newsletter IDs + + (you can pass them in the query parameter - see the description below). + Remember that all the statistics date ranges + + are returned in standard UTC period type objects. ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)). You + can filter the resource using criteria specified as `query[*]`. You can + provide multiple criteria, to use AND logic. You can sort the resource + using parameters specified as `sort[*]`. You can specify multiple fields + to sort by. + operationId: getNewsletterStatisticsCollection + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[newsletterId] + in: query + description: The list of newsletter resource IDs (string separated with '') + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: The list of campaign resource IDs (string separated with '') + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /tags: + get: + tags: + - Tags + summary: Get the list of tags + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getTagsList + parameters: + - name: query[name] + in: query + description: Search tags by name + required: false + schema: + type: string + - name: query[createdAt][from] + in: query + description: Search tags created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdAt][to] + in: query + description: Search tags created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdAt] + in: query + description: Sort tags by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TagList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Tags + summary: Add a new tag + operationId: createTag + requestBody: + $ref: '#/components/requestBodies/NewTag' + responses: + '201': + $ref: '#/components/responses/TagDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /addresses: + get: + tags: + - Addresses + summary: Get a list of addresses + description: >- + + Sending a **GET** request to this URL returns collection of address + resources. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + + * firstName + + * lastName + + * address1 + + * address2 + + * city + + * zip + + * province + + * provinceCode + + * phone + + * company + + * createdOn + + + The `name` field can be a pattern and we'll try to match this phrase. + + + You can specify which page of the results you want and how many results + per page to display. You can also specify the sort-order using one or + more of the allowed fields (listed below in the request params section). + + + Last but not least, you can even specify which fields from a resource + you want to get. If you pass the param `fields` with the list of fields + (separated by a comma [,]) we'll return the list of resources with only + those fields (we'll always add a resource ID to ensure that you can use + that data later on) + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getAddressList + parameters: + - name: query[name] + in: query + description: Search addresses by name + required: false + schema: + type: string + - name: query[firstName] + in: query + description: Search addresses by first name + required: false + schema: + type: string + - name: query[lastName] + in: query + description: Search addresses by last name + required: false + schema: + type: string + - name: query[address1] + in: query + description: Search addresses by address1 field + required: false + schema: + type: string + - name: query[address2] + in: query + description: Search addresses by address2 field + required: false + schema: + type: string + - name: query[city] + in: query + description: Search addresses by city + required: false + schema: + type: string + - name: query[zip] + in: query + description: Search addresses by ZIP + required: false + schema: + type: string + - name: query[province] + in: query + description: Search addresses by province + required: false + schema: + type: string + - name: query[provinceCode] + in: query + description: Search addresses by province code + required: false + schema: + type: string + - name: query[phone] + in: query + description: Search addresses by phone + required: false + schema: + type: string + - name: query[company] + in: query + description: Search addresses by company + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search addresses created from this date + required: false + schema: + type: string + format: date-time + - name: query[createdOn][to] + in: query + description: Search addresses created to this date + required: false + schema: + type: string + format: date-time + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AddressList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Addresses + summary: Create address + description: '' + operationId: createAddress + requestBody: + $ref: '#/components/requestBodies/NewAddress' + responses: + '201': + $ref: '#/components/responses/AddressDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/blocklists: + get: + tags: + - Accounts + summary: Returns account blocklist masks + operationId: getAccountBlocklist + parameters: + - name: query[mask] + in: query + description: Blocklist mask to search for + required: false + schema: + type: string + example: '@somedomain.com' + responses: + '200': + $ref: '#/components/responses/AccountBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Accounts + summary: Update account blocklist + operationId: updateAccountBlocklist + parameters: + - name: additionalFlags + in: query + description: >- + The flag value `add` adds the masks provided in the request body to + your blocklist. The flag value `delete` deletes the masks. The masks + are replaced if there are no flag values in the request body. + + For better performance, use the flag value `noResponse`. It removes the response body and can be used alone or combined with other flags. If multiple flags are used, separate them by a comma, like this: `additionalFlags=noResponse` or `additionalFlags=add,noResponse`. + required: false + schema: + type: string + enum: + - add + - delete + - noResponse + requestBody: + $ref: '#/components/requestBodies/UpdateAccountBlocklist' + responses: + '200': + $ref: '#/components/responses/AccountBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: update + /custom-fields: + get: + tags: + - Custom Fields + summary: Get a list of custom fields + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getCustomFieldList + parameters: + - name: query[name] + in: query + description: Search custom fields by name + required: false + schema: + type: string + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CustomFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Custom Fields + summary: Create a custom field + operationId: createCustomField + requestBody: + $ref: '#/components/requestBodies/NewCustomField' + responses: + '201': + $ref: '#/components/responses/CustomFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /lps: + get: + tags: + - Landing Pages + summary: Get the list of landing pages + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getLpsList + parameters: + - name: query[name] + in: query + description: Search landing pages by name + required: false + schema: + type: string + - name: query[status] + in: query + description: Search landing pages by status + required: false + schema: + type: string + enum: + - published + - unpublished + - name: stats[from] + in: query + description: Show statistics for landing pages from this date + required: false + schema: + type: string + format: date-time + - name: stats[to] + in: query + description: Show statistics for landing pages to this date + required: false + schema: + type: string + format: date-time + - name: sort[name] + in: query + description: Sort landing pages by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdAt] + in: query + description: Sort landing pages by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[updatedAt] + in: query + description: Sort landing pages by modification date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[visits] + in: query + description: Sort by number of page visits + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[leads] + in: query + description: Sort landing pages by number of leads + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subscriptionRate] + in: query + description: Sort by subscription rate + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/LpsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /multimedia: + get: + tags: + - Multimedia + summary: Get images list + operationId: getImageList + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ImageList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Multimedia + summary: Upload image + operationId: uploadImage + requestBody: + $ref: '#/components/requestBodies/CreateMultimedia' + responses: + '200': + $ref: '#/components/responses/ImageDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: CreateMultimedia + x-type: upload + /tracking: + get: + tags: + - Tracking + summary: Get Tracking JavaScript code snippets + description: >- + With code snippets you will be able to track Purchases, Abandoned carts, + and Visited URLs. Find more in our [Help + Center](https://www.getresponse.com/help/marketing-automation/ecommerce-conditions/how-do-i-add-the-tracking-javascript-code-to-my-website.html). + operationId: getTracking + responses: + '200': + $ref: '#/components/responses/Tracking' + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /tracking/facebook-pixels: + get: + tags: + - Tracking + summary: Get the list of "Facebook Pixels" + description: >- + Returns the name and ID of "Facebook Pixels" assigned to a user's + account. + operationId: getFacebookPixelList + responses: + '200': + $ref: '#/components/responses/FacebookPixelList' + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts: + get: + tags: + - Accounts + summary: Account information + operationId: getAccount + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AccountDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Accounts + summary: Update account + operationId: updateAccount + requestBody: + $ref: '#/components/requestBodies/UpdateAccount' + responses: + '200': + $ref: '#/components/responses/AccountDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: UpdateAccount + /accounts/billing: + get: + tags: + - Accounts + summary: Billing information + operationId: getAccountBilling + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AccountBillingDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/login-history: + get: + tags: + - Accounts + summary: History of logins + operationId: getAccountLoginHistory + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AccountLoginHistoryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/badge: + get: + tags: + - Accounts + summary: Current status of your GetResponse badge + operationId: getAccountBadge + responses: + '200': + $ref: '#/components/responses/AccountBadgeDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Accounts + summary: Turn on/off the GetResponse Badge + operationId: updateAccountBadge + requestBody: + $ref: '#/components/requestBodies/UpdateAccountBadge' + responses: + '200': + $ref: '#/components/responses/AccountBadgeDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: update + /accounts/industries: + get: + tags: + - Accounts + summary: List of Industry Tags + description: List of Industry Tags in account's language context. + operationId: getIndustries + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/IndustryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/timezones: + get: + tags: + - Accounts + summary: List of timezones + description: List of timezones in account's language context. + operationId: getTimezones + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AccountTimezoneList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/callbacks: + get: + tags: + - Accounts + summary: Get callbacks configuration + operationId: getCallbacks + responses: + '200': + $ref: '#/components/responses/Callback' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Callbacks are disabled for the account + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Accounts + summary: Enable or update callbacks configuration + operationId: updateCallbacks + requestBody: + $ref: '#/components/requestBodies/UpdateCallbacks' + responses: + '200': + $ref: '#/components/responses/Callback' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: UpdateCallback + delete: + tags: + - Accounts + summary: Disable callbacks + operationId: disableCallbacks + responses: + '204': + description: Empty response + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/sending-limits: + get: + tags: + - Accounts + summary: Send limits + operationId: getSendingLimits + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SendingLimitsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /campaigns: + get: + tags: + - Campaigns (Lists) + summary: Get a list of campaigns + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getCampaignList + parameters: + - name: query[name] + in: query + required: false + schema: + type: string + example: campaign_name + - name: query[isDefault] + in: query + required: false + schema: + type: boolean + example: true + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CampaignList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Campaigns (Lists) + summary: Create a campaign + operationId: createCampaign + requestBody: + $ref: '#/components/requestBodies/NewCampaign' + responses: + '201': + $ref: '#/components/responses/Campaign' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /campaigns/statistics/origins: + get: + tags: + - Campaigns (Lists) + summary: Get subscriber origin statistics + description: The results are indexed with the campaign ID. + operationId: getCampaignStatisticsOrigins + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/CampaignOriginsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsOrigins + /campaigns/statistics/locations: + get: + tags: + - Campaigns (Lists) + summary: Get subscriber location statistics + description: The results are indexed with the location name (PL, EN, etc.). + operationId: getCampaignStatisticsLocations + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/CampaignLocationsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsLocations + /campaigns/statistics/list-size: + get: + tags: + - Campaigns (Lists) + summary: Get campaign size statistics + description: >- + Returns the number of the total added and removed subscribers, grouped + by default or by time period. + operationId: getCampaignStatisticsListSize + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/CampaignListSizesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsListSize + /campaigns/statistics/subscriptions: + get: + tags: + - Campaigns (Lists) + summary: Get the number and origin of subscription statistics + description: >- + Returns the number and origin of subscriptions, grouped by a specified + campaigns for each day on which any changes were made. Dates in the + YYYY-MM-DD format are used as keys in the response. + operationId: getCampaignStatisticsSubscriptions + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/SubscriptionsByDatesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsSubscriptions + /campaigns/statistics/removals: + get: + tags: + - Campaigns (Lists) + summary: Get removal statistics + description: >- + Returns the number and reason for removed contacts. Dates in the + YYYY-MM-DD format are used as keys in the response. + operationId: getCampaignStatisticsRemovals + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/RemovalsByDatesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsRemovals + /campaigns/statistics/balance: + get: + tags: + - Campaigns (Lists) + summary: Get balance statistics + description: >- + Returns the balance of subscriptions. Dates in the YYYY-MM-DD format are + used as keys in the response. + operationId: getCampaignStatisticsBalance + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/BalanceByDatesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsBalance + /campaigns/statistics/summary: + get: + tags: + - Campaigns (Lists) + summary: Get the statistics summary for selected campaigns + description: The results are indexed with the campaign ID. + operationId: getCampaignStatisticsSummary + parameters: + - name: query[campaignId] + in: query + required: false + schema: + $ref: '#/components/schemas/CampaignStatisticsIdQuery' + responses: + '200': + $ref: '#/components/responses/CampaignSummaryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsSummary + /webforms: + get: + tags: + - Legacy Forms + summary: Get Legacy Forms. + description: >- + Get the list of Legacy Forms. You can filter the resource using criteria + specified as `query[*]`. You can provide multiple criteria, to use AND + logic. You can sort the resource using parameters specified as + `sort[*]`. You can specify multiple fields to sort by. + operationId: getLegacyFormList + parameters: + - name: query[name] + in: query + description: Search Legacy Forms by name + required: false + schema: + type: string + - name: query[modifiedOn][from] + in: query + description: Search Legacy Forms modified from this date + required: false + schema: + type: string + format: date-time + - name: query[modifiedOn][to] + in: query + description: Search Legacy Forms modified to this date + required: false + schema: + type: string + format: date-time + - name: query[campaignId] + in: query + description: >- + Search Legacy Forms by campaignId. Accepts multiple IDs separated + with a comma + required: false + schema: + type: string + - name: sort[modifiedOn] + in: query + description: Sort Legacy Forms by modification date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/LegacyFormList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /gdpr-fields: + get: + tags: + - GDPR Fields + summary: Get the GDPR fields list + operationId: getGDPRFieldList + parameters: + - name: sort[name] + in: query + description: Sort fields by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort fields by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/GDPRFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /workflow: + get: + tags: + - Workflows + summary: Get workflows + description: Get the list of workflows. + operationId: getWorkflowList + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/WorkflowList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetWorkflows + /sms-automation: + get: + tags: + - SMS Automation Messages + summary: Get the list of automated SMS messages. + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getSMSAutomationList + parameters: + - name: query[name] + in: query + description: Search automated SMS messages by name + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: Search automated SMS messages by campaign (list) ID + required: false + schema: + type: string + - name: query[hasLinks] + in: query + description: Search for automated SMS messages containing links + required: false + schema: + type: boolean + - name: sort[status] + in: query + description: Sort by the status of the SMS message + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + description: Sort by the name of the automated SMS message + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[modifiedOn] + in: query + description: Sort by the date the SMS message was modified on + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[delivered] + in: query + description: Sort by the number of delivered SMS messages + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[sent] + in: query + description: Sort by the number of sent SMS messages + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[clicks] + in: query + description: Sort by the number of link clicks + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SmsAutomationList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /sms: + get: + tags: + - SMS Messages + summary: Get the list of SMS messages. + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getSMSList + parameters: + - name: query[type] + in: query + description: Search SMS messages by type + required: false + schema: + type: string + enum: + - sms + - draft + - name: query[name] + in: query + description: Search SMS messages by name + required: false + schema: + type: string + - name: query[sendingStatus] + in: query + description: Search SMS messages by status + required: false + schema: + type: string + enum: + - scheduled + - sending + - sent + - name: query[campaignId] + in: query + description: Search SMS messages by campaign (list) ID + required: false + schema: + type: string + - name: query[hasLinks] + in: query + description: Search for SMS messages with links + required: false + schema: + type: boolean + - name: sort[sendingStatus] + in: query + description: Sort by sending status + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[sendOn] + in: query + description: Sort by sending date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[modifiedOn] + in: query + description: Sort by modification date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[delivered] + in: query + description: Sort by number of delivered messages + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[sent] + in: query + description: Sort by number of sent messages + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[clicks] + in: query + description: Sort by number of link clicks + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SmsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /autoresponders: + get: + tags: + - Autoresponders + summary: Get the list of autoresponders. + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getAutoresponderList + parameters: + - name: query[subject] + in: query + description: Search autoresponder by subject + required: false + schema: + type: string + - name: query[name] + in: query + description: Search autoresponder by name + required: false + schema: + type: string + - name: query[status] + in: query + description: Search autoresponder by status + required: false + schema: + type: string + enum: + - enabled + - disabled + - name: query[createdOn][from] + in: query + description: Search autoresponder created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search autoresponder created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[campaignId] + in: query + description: Search autoresponder by campaign ID + required: false + schema: + type: string + - name: query[type] + in: query + description: Search autoresponder by type + required: false + schema: + type: string + enum: + - timebase + - actionbase + - name: query[triggerType] + in: query + description: Search autoresponder by triggerType + required: false + schema: + type: string + enum: + - onday + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subject] + in: query + description: Sort by subject + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[dayOfCycle] + in: query + description: Sort by cycle day + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[delivered] + in: query + description: Sort by delivered + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[openRate] + in: query + description: Sort by open rate + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[clickRate] + in: query + description: Sort by click rate + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AutoresponderList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Autoresponders + summary: Create autoresponder + description: > + > + + **The action-based autoresponder feature has been migrated over to + marketing automation. Your existing autoresponders are + + now converted into workflows. You can no longer create and update + action-based autoresponders using our API.** + + + This request allows you to create an autoresponder. Remember to select + the proper `sendSettings` - depending on `type` you need to fill + corresponding setting (eg. if you selected type `delay`, then you MUST + fill `delayInHours` field). + operationId: createAutoresponder + requestBody: + $ref: '#/components/requestBodies/NewAutoresponder' + responses: + '201': + $ref: '#/components/responses/AutoresponderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /autoresponders/statistics: + get: + tags: + - Autoresponders + summary: The statistics for all autoresponders + description: >- + > + + This returns the statistics summary for selected autoresponders. You can + select them by specifying the autoresponder or campaign IDs. + + As in all statistics, you can change the date and time range (hourly + daily monthly or total). Keep in mind + + that all statistics date ranges are given in standard UTC period type + objects. ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)) + + + (https://app.getresponse.com/statistics.html?t=followup#total). + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getAutoresponderStatisticsCollection + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[autoreponderId] + in: query + description: The list of autoresponder resource IDs (string separated with '') + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: The list of campaign resource IDs (string separated with '') + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetAutorespondersStatistics + /websites: + get: + tags: + - Websites + summary: Get the list of websites + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getWebsitesList + parameters: + - name: query[name] + in: query + description: Search websites by name + required: false + schema: + type: string + - name: query[status] + in: query + description: Search websites by status + required: false + schema: + type: string + enum: + - published + - unpublished + - name: stats[from] + in: query + description: Show statistics for websites from this date + required: false + schema: + type: string + format: date-time + - name: stats[to] + in: query + description: Show statistics for websites to this date + required: false + schema: + type: string + format: date-time + - name: sort[name] + in: query + description: Sort websites by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdAt] + in: query + description: Sort websites by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[updatedAt] + in: query + description: Sort websites by modification date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[pageViews] + in: query + description: Sort websites by page views + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[visits] + in: query + description: Sort by number of site visits + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[uniqueVisitors] + in: query + description: Sort by number of unique visitors + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/WebsitesList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + components: + schemas: + CreateAndUpdate: + properties: + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + updatedOn: + description: The date of the last update + type: string + format: date-time + readOnly: true + type: object + Shop: + properties: + shopId: + description: The shop ID + type: string + readOnly: true + example: pf3 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3 + name: + description: The shop name + type: string + maxLength: 124 + minLength: 4 + example: Monster market + locale: + description: The language locale (ISO 639-1) + type: string + example: PL + currency: + description: The currency code (ISO 4217) + type: string + example: PLN + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + NewShop: + required: + - name + - locale + - currency + type: object + allOf: + - $ref: '#/components/schemas/Shop' + BaseCategory: + properties: + categoryId: + description: The category ID + type: string + readOnly: true + example: atQ + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/categories/atQ + name: + description: The name of the category + type: string + maxLength: 64 + minLength: 2 + example: Headwear + parentId: + description: The parent category ID + type: string + maxLength: 64 + minLength: 2 + example: amh + isDefault: + description: This is a default category + type: boolean + example: true + url: + description: The external URL to the category + type: string + format: uri + maxLength: 2048 + example: https://somedomain.com/category/446 + externalId: + description: >- + The external ID is the identifying string or number of the category + given by another software + type: string + maxLength: 255 + example: ext3343 + type: object + Category: + type: object + allOf: + - $ref: '#/components/schemas/BaseCategory' + - $ref: '#/components/schemas/CreateAndUpdate' + NewCategory: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/Category' + UpdateCategory: + type: object + allOf: + - $ref: '#/components/schemas/Category' + UpdateShop: + type: object + allOf: + - $ref: '#/components/schemas/Shop' + ProductCategory: + type: object + allOf: + - $ref: '#/components/schemas/BaseCategory' + - $ref: '#/components/schemas/CreateAndUpdate' + NewProductCategory: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseCategory' + BaseMetaField: + properties: + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/meta-fields/NoF + metaFieldId: + description: The meta field ID + type: string + readOnly: true + example: NoF + name: + description: The meta field name + type: string + maxLength: 63 + minLength: 3 + example: Shoe size + value: + description: The meta field value + type: string + maxLength: 65000 + minLength: 0 + example: '11' + valueType: + description: The value type enumerable + type: string + enum: + - string + - integer + example: integer + description: + description: The meta field description + type: string + maxLength: 255 + minLength: 0 + example: Description of this meta field + type: object + MetaField: + type: object + allOf: + - $ref: '#/components/schemas/BaseMetaField' + - $ref: '#/components/schemas/CreateAndUpdate' + NewMetaField: + required: + - name + - value + - valueType + type: object + allOf: + - $ref: '#/components/schemas/BaseMetaField' + Product: + properties: + productId: + description: The product ID + type: string + readOnly: true + example: 9I + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/products/9I + name: + description: The product name + type: string + maxLength: 255 + minLength: 2 + example: Monster Cap + type: + description: The product type + type: string + maxLength: 64 + minLength: 2 + example: Headwear + url: + description: The external URL for the product + type: string + format: uri + maxLength: 2048 + example: https://somedomain.com/products/456 + vendor: + description: The product vendor + type: string + maxLength: 64 + minLength: 2 + example: GetResponse + externalId: + description: >- + The external ID is the identifying string or number of the product + given by another software + type: string + maxLength: 255 + example: '123456' + categories: + type: array + items: + $ref: '#/components/schemas/NewProductCategory' + variants: + type: array + items: + $ref: '#/components/schemas/NewProductVariant' + metaFields: + type: array + items: + $ref: '#/components/schemas/NewMetaField' + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + NewProduct: + required: + - name + - variants + type: object + allOf: + - $ref: '#/components/schemas/Product' + UpdateProduct: + type: object + allOf: + - $ref: '#/components/schemas/Product' + UpsertProductCategory: + description: >- + This method makes it possible to assign product categories, and to set a + default product category. It doesn't remove or unassign product + categories. + required: + - categories + properties: + categories: + type: array + items: + $ref: '#/components/schemas/UpsertSingleProductCategory' + type: object + UpsertSingleProductCategory: + required: + - categoryId + properties: + categoryId: + description: The category ID + type: string + example: atQ + isDefault: + description: This is a default category + type: boolean + example: true + type: object + UpsertMetaField: + description: This method assigns metafields. It doesn't unassign or delete them. + required: + - metaFields + properties: + metaFields: + type: array + items: + $ref: '#/components/schemas/UpsertSingleMetaField' + type: object + UpsertSingleMetaField: + required: + - metaFieldId + properties: + metaFieldId: + description: MetaField ID + type: string + example: NoF + type: object + UpdateMetaField: + type: object + allOf: + - $ref: '#/components/schemas/MetaField' + BaseProductVariant: + properties: + variantId: + description: The product ID + type: string + readOnly: true + example: VTB + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/products/9I/variants/VTB + name: + description: The product name + type: string + maxLength: 255 + minLength: 1 + example: Red Monster Cap + url: + description: The external URL to the product variant + type: string + format: uri + maxLength: 2048 + example: https://somedomain.com/products-variants/986 + sku: + description: >- + The stock-keeping unit of a variant. Must be unique within the + product + type: string + maxLength: 255 + minLength: 2 + example: SKU-1254-56-457-5689 + price: + description: The price + type: number + format: double + example: 20 + priceTax: + description: The price including tax + type: number + format: double + example: 27.5 + previousPrice: + description: The price before the change + type: number + format: double + example: 25 + nullable: true + previousPriceTax: + description: The price before the change including tax + type: number + format: double + example: 33.6 + nullable: true + quantity: + description: The quantity of variant items + type: integer + format: int64 + default: 1 + position: + description: The position of a variant + type: integer + format: int64 + example: 1 + barcode: + description: The barcode of a variant + type: string + maxLength: 255 + minLength: 2 + example: '12455687' + externalId: + description: >- + The external ID is the identifying string or number of the variant + given by another software + type: string + maxLength: 255 + example: ext1456 + description: + description: The description of a variant + type: string + maxLength: 1000 + minLength: 2 + example: Red Cap with GetResponse Monster print + images: + type: array + items: + $ref: '#/components/schemas/NewProductVariantImage' + metaFields: + type: array + items: + $ref: '#/components/schemas/NewMetaField' + taxes: + type: array + items: + $ref: '#/components/schemas/NewTax' + type: object + ProductVariant: + type: object + allOf: + - $ref: '#/components/schemas/BaseProductVariant' + - $ref: '#/components/schemas/CreateAndUpdate' + NewProductVariant: + required: + - name + - price + - priceTax + - sku + type: object + allOf: + - $ref: '#/components/schemas/BaseProductVariant' + UpdateProductVariant: + type: object + allOf: + - $ref: '#/components/schemas/ProductVariant' + NewProductVariantImage: + required: + - src + - position + properties: + imageId: + description: The image ID + type: string + readOnly: true + example: hY + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/images/hY + src: + description: The source URL of an image + type: string + format: uri + example: http://somedomain.com/images/src/img58db7ec64bab9.png + position: + description: The position of an image + type: integer + format: int32 + example: '1' + type: object + BaseTax: + properties: + taxId: + description: The tax ID + type: string + readOnly: true + example: Sk + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/taxes/Sk + name: + description: The tax name + type: string + maxLength: 255 + minLength: 2 + example: VAT + rate: + description: The rate value + type: number + format: double + maximum: 99.9 + minimum: 0 + example: 23 + type: object + Tax: + type: object + allOf: + - $ref: '#/components/schemas/BaseTax' + - $ref: '#/components/schemas/CreateAndUpdate' + NewTax: + required: + - name + - rate + type: object + allOf: + - $ref: '#/components/schemas/BaseTax' + UpdateTax: + type: object + allOf: + - $ref: '#/components/schemas/BaseTax' + Address: + properties: + addressId: + type: string + readOnly: true + example: k9 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/addresses/k9 + countryCode: + description: The country code (ISO 3166-1 alpha-3) + type: string + maxLength: 3 + minLength: 3 + example: POL + countryName: + description: The country name, based on `countryCode` + type: string + readOnly: true + example: Poland + name: + type: string + maxLength: 128 + minLength: 3 + example: some_shipping_address + firstName: + type: string + maxLength: 64 + minLength: 0 + example: John + lastName: + type: string + maxLength: 64 + minLength: 0 + example: Doe + address1: + description: Address line 1 + type: string + maxLength: 255 + minLength: 0 + example: Arkonska 6 + address2: + description: Address line 2 + type: string + maxLength: 255 + minLength: 0 + example: '' + city: + type: string + maxLength: 128 + minLength: 0 + example: Gdansk + zip: + description: The ZIP/postal code, free text + type: string + maxLength: 64 + minLength: 0 + example: 80-387 + province: + type: string + maxLength: 255 + minLength: 0 + example: pomorskie + provinceCode: + description: The province code, free text + type: string + maxLength: 64 + minLength: 0 + example: '' + phone: + description: The phone number, free text + type: string + maxLength: 255 + minLength: 0 + example: '1122334455' + company: + description: The company name, free text + type: string + maxLength: 128 + minLength: 0 + example: GetResponse + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + NewAddress: + required: + - name + - countryCode + type: object + allOf: + - $ref: '#/components/schemas/Address' + UpdateAddress: + type: object + allOf: + - $ref: '#/components/schemas/Address' + Order: + properties: + orderId: + description: The order ID + type: string + readOnly: true + example: fOh + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/orders/fOh + contactId: + description: >- + Create a contact by using `POST /v3/contacts`. Or, if the contact + already exists, using `GET /v3/contacts` + type: string + example: k8u + orderUrl: + description: The external URL for an order + type: string + format: uri + maxLength: 2048 + example: https://somedomain.com/orders/order446 + externalId: + description: >- + The external ID is the identifying string or number of the order + given by another software + type: string + maxLength: 255 + example: DH71239 + totalPrice: + description: The total price of an order + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 716 + totalPriceTax: + description: The total price tax of an order + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 358.67 + currency: + description: The order currency code (ISO 4217) + type: string + example: PLN + status: + description: The status value + type: string + maxLength: 64 + example: NEW + cartId: + description: Create a cart by using `POST /v3/shops/{shopId}/carts` + type: string + example: QBNgBR + description: + description: The order description + type: string + example: More information about order. + shippingPrice: + description: The shipping price for an order + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 23 + shippingAddress: + description: The shipping address for an order + allOf: + - $ref: '#/components/schemas/NewAddress' + billingStatus: + description: The billing status of an order + type: string + example: PENDING + billingAddress: + description: The billing address for an order + allOf: + - $ref: '#/components/schemas/NewAddress' + processedAt: + description: The exact time an order was made + type: string + format: date-time + metaFields: + type: array + items: + $ref: '#/components/schemas/NewMetaField' + type: object + OrderResponse: + properties: + selectedVariants: + type: array + items: + $ref: '#/components/schemas/OrderSelectedProductVariant' + type: object + allOf: + - $ref: '#/components/schemas/Order' + NewOrder: + required: + - contactId + - totalPrice + - currency + - selectedVariants + properties: + selectedVariants: + type: array + items: + $ref: '#/components/schemas/NewSelectedProductVariant' + type: object + allOf: + - $ref: '#/components/schemas/Order' + UpdateOrder: + type: object + allOf: + - $ref: '#/components/schemas/Order' + NewSelectedProductVariant: + required: + - variantId + - price + - quantity + properties: + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/aS/products/Rf/variants/aBc + variantId: + description: >- + The ID of a selected variant. You must first create a variant + using: + + + `POST` [Create + product](https://apireference.getresponse.com/#operation/createProduct) + + + `POST` [Create product + variant](https://apireference.getresponse.com/#operation/createProductVariant) + + or get ID from variants created already: + + `GET` [Get a list of product variants](https://apireference.getresponse.com/#operation/getProductVariantList) + type: string + example: p + price: + description: The product variant price + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 840 + priceTax: + description: The product variant price tax + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 428 + quantity: + description: The product variant quantity + type: integer + format: int32 + minimum: 1 + example: '2' + taxes: + type: array + items: + $ref: '#/components/schemas/NewTax' + type: object + OrderSelectedProductVariant: + required: + - variantId + - price + - quantity + properties: + categories: + type: array + items: + $ref: '#/components/schemas/BaseCategory' + type: object + allOf: + - $ref: '#/components/schemas/NewSelectedProductVariant' + NewCartSelectedProductVariant: + required: + - variantId + - quantity + - price + - priceTax + properties: + variantId: + description: >- + The ID of a selected variant. You must first create a variant + using: + + + `POST` [Create + product](https://apireference.getresponse.com/#operation/createProduct) + + + `POST` [Create product + variant](https://apireference.getresponse.com/#operation/createProductVariant) + + or get ID from variants created already: + + `GET` [Get a list of product variants](https://apireference.getresponse.com/#operation/getProductVariantList) + type: string + example: VTB + quantity: + description: The quantity + type: integer + format: int64 + minimum: 1 + example: 3 + price: + description: The price, tax excluded + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 57 + priceTax: + description: The price, tax included + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 68 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/products/9I/variants/VTB + type: object + Cart: + properties: + cartId: + description: The contact ID + type: string + readOnly: true + example: V + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/carts/V + contactId: + description: >- + The ID of the contact that the cart belongs to. You must first + create the contact using POST /v3/contacts, or if it already exists, + using GET /v3/contacts + type: string + example: Vp + totalPrice: + description: The total cart price, tax excluded + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 1234.56 + totalTaxPrice: + description: The total cart price, tax included + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 1334.56 + currency: + description: The currency code (ISO 4217) + type: string + maxLength: 3 + minLength: 3 + example: USD + selectedVariants: + type: array + items: + $ref: '#/components/schemas/NewCartSelectedProductVariant' + externalId: + description: >- + The external ID is the identifying string or number of the cart, + given by another software + type: string + example: ext-1234 + cartUrl: + description: The external cart URL + type: string + format: url + example: http://example.com/cart/nQ + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + NewCart: + required: + - contactId + - totalPrice + - currency + - selectedVariants + type: object + allOf: + - $ref: '#/components/schemas/Cart' + UpdateCart: + type: object + allOf: + - $ref: '#/components/schemas/Cart' + Webinar: + properties: + webinarId: + type: string + readOnly: true + example: yK6d + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/webinars/yK6d + createdOn: + type: string + format: date-time + readOnly: true + startsOn: + type: string + format: date-time + webinarUrl: + description: The URL to the webinar room + type: string + format: uri + status: + type: string + enum: + - upcoming + - finished + - published + - unpublished + readOnly: true + type: + description: The webinar type + type: string + enum: + - all + - live + - on_demand + readOnly: true + campaigns: + type: array + items: + $ref: '#/components/schemas/CampaignReference' + newsletters: + description: The list of invitation messages + type: array + items: + $ref: '#/components/schemas/WebinarNewsletter' + statistics: + type: object + $ref: '#/components/schemas/WebinarStatistics' + type: object + WebinarStatistics: + required: + - registrants + - visitors + - attendees + properties: + registrants: + type: integer + format: int64 + example: 15 + visitors: + type: integer + format: int64 + example: 10 + attendees: + type: integer + format: int64 + example: 5 + type: object + WebinarNewsletter: + required: + - newsletterId + - href + properties: + newsletterId: + description: The ID of the webinar invitation message + type: string + example: NuE4 + href: + description: Direct hyperlink to a resource + type: string + example: https://api.getresponse.com/v3/newsletters/NuE4 + type: object + ContactCustomField: + properties: + customFieldId: + type: string + example: kL6Nh + values: + type: array + items: + type: string + example: 18-35 + type: object + ContactActivity: + properties: + activity: + description: The type of activity + type: string + enum: + - send + - open + - click + example: click + subject: + type: string + example: Shop offer update! + createdOn: + description: The activity date + type: string + format: date-time + previewUrl: + description: >- + This is only available for the `send` activity. It includes a link + to the message preview + type: string + format: uri + example: >- + https://www.grnewsletters.com/archive/campaign_name55f6b0ff01/Test-2135303.html + nullable: true + resource: + type: object + $ref: '#/components/schemas/ContactActivityResource' + clickTrack: + description: >- + This is only available for the `click` activity. It includes the + clicked link data + type: object + nullable: true + $ref: '#/components/schemas/ContactActivityClickTrack' + type: object + readOnly: true + ContactActivityClickTrack: + properties: + id: + description: The click tracking ID + type: string + example: 62WrE + name: + description: The name of the clicked link + type: string + example: Go to shop + url: + description: The URL of the clicked link + type: string + format: uri + example: https://my-shop.example.com/ + type: object + ContactActivityResource: + properties: + resourceId: + type: string + example: oY2n + nullable: true + resourceType: + type: string + enum: + - newsletters + - splittests + - autoresponders + - rss-newsletters + - sms + example: newsletters + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/newsletters/oY2n + type: object + ContactCustomFieldList: + type: array + items: + $ref: '#/components/schemas/ContactCustomField' + ContactListElement: + allOf: + - $ref: '#/components/schemas/Contact' + - properties: + note: + type: string + maxLength: 255 + minLength: 0 + nullable: true + ipAddress: + description: The contact's IP address. IPv4 and IPv6 formats are accepted. + example: 1.2.3.4 + oneOf: + - type: string + format: ipv4 + - type: string + format: ipv6 + type: object + ContactDetails: + type: object + allOf: + - $ref: '#/components/schemas/ContactListElement' + - properties: + geolocation: + type: object + readOnly: true + $ref: '#/components/schemas/ContactGeolocation' + tags: + description: The list of contact tags, limited to 500 tags. + type: array + items: + $ref: '#/components/schemas/ContactTag' + customFieldValues: + type: array + items: + $ref: '#/components/schemas/ContactCustomFieldValue' + type: object + ContactCustomFieldValue: + required: + - customFieldId + - name + - type + - value + - values + properties: + customFieldId: + description: Custom field ID + type: string + example: 4klkN + name: + type: string + example: age + value: + type: array + items: + type: string + example: 18-35 + values: + type: array + items: + type: string + example: 18-35 + type: + type: string + example: single_select + fieldType: + type: string + example: single_select + valueType: + type: string + example: string + type: object + ContactGeolocation: + properties: + latitude: + type: string + example: '54.35' + nullable: true + longitude: + type: string + example: '18.6667' + nullable: true + continentCode: + type: string + enum: + - OC + - AN + - SA + - NA + - AS + - EU + - AF + example: EU + nullable: true + countryCode: + description: The country code, compliant with ISO 3166-1 alpha-2 + type: string + example: PL + nullable: true + region: + type: string + example: '82' + nullable: true + postalCode: + type: string + example: 80-387 + nullable: true + dmaCode: + type: string + nullable: true + city: + type: string + example: Gdansk + nullable: true + type: object + BaseSearchContacts: + description: The short description of a saved search. + properties: + searchContactId: + description: The unique search-contact identifier + type: string + readOnly: true + example: pV3r + name: + description: The unique name of search-contact + type: string + example: custom test filter + createdOn: + description: The UTC date time format ISO 8601, e.g. 2018-04-10T10:02:57+0000 + type: string + format: date-time + readOnly: true + example: 2018-04-10T10:02:57+0000 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://app.getresponse.com/v3/search-contacts/pV3r + type: object + BaseSearchContactsDetails: + required: + - searchContactId + type: object + allOf: + - $ref: '#/components/schemas/BaseSearchContacts' + SearchContactsDetails: + description: Search contact details. + required: + - searchContactId + - name + - createdOn + - href + type: object + allOf: + - $ref: '#/components/schemas/SearchContactsConditionsDetails' + - $ref: '#/components/schemas/BaseSearchContacts' + SearchContactsConditionsDetails: + required: + - subscribersType + - sectionLogicOperator + - section + properties: + subscribersType: + description: Only one subscription status + type: array + items: + type: string + enum: + - subscribed + - undelivered + - removed + - unconfirmed + example: + - subscribed + sectionLogicOperator: + description: >- + Match 'any' (`or` value) or 'all' (`and` value) of the following + conditions + type: string + enum: + - or + - and + example: or + section: + type: array + items: + $ref: '#/components/schemas/SearchContactSection' + type: object + example: + subscribersType: + - subscribed + sectionLogicOperator: or + section: + - campaignIdsList: + - tamqY + logicOperator: or + subscriberCycle: + - receiving_autoresponder + - not_receiving_autoresponder + subscriptionDate: all_time + conditions: + - conditionType: crm + pipelineScope: PSVq + stageScope: all + NewSearchContacts: + description: New search contacts. + required: + - name + - subscribersType + - sectionLogicOperator + - section + type: object + allOf: + - $ref: '#/components/schemas/SearchContactsConditionsDetails' + - $ref: '#/components/schemas/BaseSearchContacts' + UpdateSearchContacts: + description: New search contacts. + required: + - name + - subscribersType + - sectionLogicOperator + - section + type: object + allOf: + - $ref: '#/components/schemas/SearchContactsConditionsDetails' + - $ref: '#/components/schemas/BaseSearchContacts' + SpecificDateEnum: + description: The specific date. + type: string + enum: + - today + - yesterday + - last_7_days + - last_30_days + - last_n_days + - this_week + - last_week + - this_month + - last_month + example: last_30_days + SpecificDateExtendedEnum: + description: The specific date. + type: string + example: last_30_days + oneOf: + - $ref: '#/components/schemas/SpecificDateEnum' + - description: The last 2 months specific date constant. + enum: + - last_2_months + RelationalNumericOperatorEnum: + description: The relational operators. + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_lt + MessageTypeOperator: + description: The type of message. + type: string + enum: + - autoresponder + - newsletter + - splittest + - automation + example: autoresponder + SearchedContactDetails: + properties: + contactId: + description: The contact identifier + type: string + example: jtLF5i + name: + description: The contact description + type: string + example: John Doe + nullable: true + email: + type: string + format: email + example: john.doe@example.com + origin: + type: string + enum: + - import + - email + - www + - panel + - leads + - sale + - api + - forward + - survey + - iphone + - copy + - landing_page + - webinar + example: landing_page + dayOfCycle: + type: string + format: integer + example: '153' + nullable: true + createdOn: + type: string + format: date-time + example: 2018-01-15T13:30:42+0000 + campaign: + type: object + example: + campaignId: tamqY + name: test_campaign + href: https://api.getresponse.com/v3/campaigns/tamqY + $ref: '#/components/schemas/CampaignReference' + score: + type: string + format: integer + example: '5' + nullable: true + reason: + type: string + enum: + - api + - automation + - blacklisted + - bounce + - cleaner + - complaint + - support + - unsubscribe + - user + example: support + nullable: true + deletedOn: + type: string + format: date-time + example: 2024-02-12T11:00:00+0000 + nullable: true + type: object + readOnly: true + SpecificDateType: + description: The date formatted as yyyy-mm-dd + type: string + format: date + example: '2018-04-01' + SpecificDateTimeType: + description: The date time string compliant with ISO 8601 + type: string + format: date + example: 2018-04-01T00:00:00+0000 + IntervalDateType: + description: >- + The date interval string compliant with ISO 8601, supported format: + / + type: string + example: 2018-04-01/2018-04-10 + ConditionStringOperator: + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - string_operator + example: string_operator + operator: + type: string + enum: + - is + - is_not + - contains + - not_contains + - starts + - ends + - not_starts + - not_ends + example: is_not + value: + type: string + example: new + type: object + example: + operatorType: string_operator + operator: starts + value: new + ConditionStringOperatorList: + description: Used with a custom field only. + required: + - operatorType + - operator + properties: + operatorType: + type: string + enum: + - string_operator_list + example: string_operator_list + operator: + type: string + enum: + - is + - is_not + - contains + - not_contains + - starts + - ends + - not_starts + - not_ends + - assigned + - not_assigned + example: is + value: + description: The value of the search + type: string + example: 18-29 + type: object + example: + operatorType: string_operator_list + operator: is + value: 18-29 + ConditionMessageOperator: + description: The operator allows searching by message type. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - message_operator + example: message_operator + operator: + $ref: '#/components/schemas/MessageTypeOperator' + value: + description: >- + The identifier of a selected resource: autoresponder, newsletter, + split test or automation message + type: string + example: SGNLr + type: object + example: + operatorType: message_operator + operator: autoresponder + value: SGNLr + CustomDateRange: + required: + - from + - to + properties: + from: + description: The UTC date format + type: string + format: date + example: '2018-04-01' + to: + description: The UTC date format + type: string + format: date + example: '2018-04-10' + type: object + SectionAllTimeSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionTodaySubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionYesterdaySubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionLast7DaysSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionLast30DaysSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionThisWeekSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionLastWeekSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionThisMonthSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionLastMonthSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionLast2MonthsSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionCustomSubscriptionDate: + required: + - customDate + properties: + customDate: + type: object + $ref: '#/components/schemas/CustomDateRange' + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SearchContactSection: + required: + - campaignIdsList + - logicOperator + - subscriberCycle + - subscriptionDate + properties: + campaignIdsList: + description: An array of campaign identifiers + type: array + items: + type: string + example: tamqY + example: + - tamqY + - tuKd3 + logicOperator: + type: string + enum: + - and + - or + subscriberCycle: + description: Defining whether or not a subscriber is in an autoresponder cycle + type: array + items: + type: string + enum: + - receiving_autoresponder + - not_receiving_autoresponder + example: + - receiving_autoresponder + - not_receiving_autoresponder + conditions: + description: One of the search contact conditions + type: array + items: + $ref: '#/components/schemas/ConditionType' + subscriptionDate: + description: Matches the matching period + type: string + enum: + - all_time + - today + - yesterday + - last_7_days + - last_30_days + - this_week + - last_week + - this_month + - last_month + - last_2_months + - custom + type: object + discriminator: + propertyName: subscriptionDate + mapping: + all_time: '#/components/schemas/SectionAllTimeSubscriptionDate' + today: '#/components/schemas/SectionTodaySubscriptionDate' + yesterday: '#/components/schemas/SectionYesterdaySubscriptionDate' + last_7_days: '#/components/schemas/SectionLast7DaysSubscriptionDate' + last_30_days: '#/components/schemas/SectionLast30DaysSubscriptionDate' + this_week: '#/components/schemas/SectionThisWeekSubscriptionDate' + last_week: '#/components/schemas/SectionLastWeekSubscriptionDate' + this_month: '#/components/schemas/SectionThisMonthSubscriptionDate' + last_month: '#/components/schemas/SectionLastMonthSubscriptionDate' + last_2_months: '#/components/schemas/SectionLast2MonthsSubscriptionDate' + custom: '#/components/schemas/SectionCustomSubscriptionDate' + ConditionType: + required: + - conditionType + properties: + conditionType: + type: string + enum: + - name + - email + - custom + - subscription_date + - subscription_method + - opened + - not_opened + - phase + - last_send_date + - last_click_date + - last_open_date + - webinar + - clicked + - not_clicked + - sent + - not_sent + - geo + - scoring + - engagement_score + - tag + - goal + - crm + - ecommerce_number_of_purchases + - ecommerce_total_spent + - ecommerce_product_purchased + - ecommerce_brand_purchased + - ecommerce_abandoned_cart + - sms_sent + - sms_delivered + - sms_link_clicked + - sms_link_not_clicked + - custom_event + type: object + discriminator: + propertyName: conditionType + mapping: + name: '#/components/schemas/NameCondition' + email: '#/components/schemas/EmailCondition' + custom: '#/components/schemas/CustomFieldCondition' + subscription_date: '#/components/schemas/SubscriptionDateCondition' + subscription_method: '#/components/schemas/SubscriptionMethodCondition' + opened: '#/components/schemas/OpenedCondition' + not_opened: '#/components/schemas/NotOpenedCondition' + phase: '#/components/schemas/AutoresponderDayCondition' + last_send_date: '#/components/schemas/LastSendDateCondition' + last_click_date: '#/components/schemas/LastClickDateCondition' + last_open_date: '#/components/schemas/LastOpenDateCondition' + webinar: '#/components/schemas/WebinarCondition' + clicked: '#/components/schemas/LinkClickedCondition' + not_clicked: '#/components/schemas/LinkNotClickedCondition' + sent: '#/components/schemas/MessageSentCondition' + not_sent: '#/components/schemas/MessageNotSentCondition' + geo: '#/components/schemas/GeolocationCondition' + scoring: '#/components/schemas/ScoringCondition' + engagement_score: '#/components/schemas/EngagementScoreCondition' + tag: '#/components/schemas/TagCondition' + goal: '#/components/schemas/GoalCondition' + crm: '#/components/schemas/CrmCondition' + ecommerce_number_of_purchases: '#/components/schemas/ECommerceNumberOfPurchasesCondition' + ecommerce_total_spent: '#/components/schemas/ECommerceTotalSpentCondition' + ecommerce_product_purchased: '#/components/schemas/ECommerceProductPurchasedCondition' + ecommerce_brand_purchased: '#/components/schemas/ECommerceBrandPurchasedCondition' + sms_sent: '#/components/schemas/SmsSentCondition' + sms_delivered: '#/components/schemas/SmsDeliveredCondition' + sms_link_clicked: '#/components/schemas/SmsLinkClickedCondition' + sms_link_not_clicked: '#/components/schemas/SmsLinkNotClickedCondition' + ecommerce_abandoned_cart: '#/components/schemas/ECommerceAbandonedCartCondition' + custom_event: '#/components/schemas/CustomEventCondition' + NameCondition: + type: object + example: + conditionType: name + operatorType: string_operator + operator: contains + value: John + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionStringOperator' + EmailCondition: + type: object + example: + conditionType: email + operatorType: string_operator + operator: contains + value: john + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionStringOperator' + CustomFieldCondition: + description: Search a contact by custom fields. + required: + - operator + - scope + - operatorType + properties: + operatorType: + description: >- + Depends on the type of custom field, read more in [custom field + condition documentation in segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual#get-by-custom-fields-search-contacts) + type: string + enum: + - string_operator_list + - string_operator + - numeric_operator + - date_operator + example: string_operator_list + operator: + description: >- + Depends on selected `"operatorType"`, read more in [custom field + condition documentation in segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual#get-by-custom-fields-search-contacts) + type: string + example: is + oneOf: + - $ref: '#/components/schemas/CustomFieldStringOperatorEnum' + - $ref: '#/components/schemas/CustomFieldNumericOperatorEnum' + - $ref: '#/components/schemas/CustomFieldDateOperatorEnum' + value: + description: >- + Depends on selected `"operator"` and `"operatorType"`, read more in + [custom field condition documentation in segments (search contacts) + reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual#get-by-custom-fields-search-contacts) + type: string + example: new + oneOf: + - $ref: '#/components/schemas/CustomFieldValueForStringOperatorTypes' + - $ref: '#/components/schemas/CustomFieldValueForNumericOperatorType' + - $ref: >- + #/components/schemas/CustomFieldValueForOperatorTypeDateAndOperatorSpecificDate + - $ref: >- + #/components/schemas/CustomFieldValueDateForOperatorTypeDateAndOperatorDateToOrDateFrom + - $ref: >- + #/components/schemas/CustomFieldValueDateTimeForOperatorTypeDateAndOperatorDateToOrDateFrom + - $ref: >- + #/components/schemas/CustomFieldValueForOperatorTypeDateAndOperatorCustom + scope: + description: >- + The identifier of the custom field, read more in [custom field + condition documentation in segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual#get-by-custom-fields-search-contacts) + type: string + numberOfDays: + description: >- + Required only when `"value":"last_n_days"`, read more in [custom + field condition documentation in segments (search contacts) + reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual#get-by-custom-fields-search-contacts) + type: integer + example: 20 + includeCurrentPeriod: + description: >- + Flag determines if current day will be included into chosen range. + This flag can be used with `last_n_days`. + type: boolean + example: true + type: object + example: + conditionType: custom + scope: pa3N6 + operatorType: string_operator_list + operator: is + value: Female + allOf: + - $ref: '#/components/schemas/ConditionType' + CustomFieldStringOperatorEnum: + description: >- + Allowed operators for `"operatorType":"string_operator"` and + `"operatorType":"string_operator_list"` + type: string + enum: + - is + - is_not + - contains + - not_contains + - starts + - ends + - not_starts + - not_ends + - assigned + - not_assigned + example: is + CustomFieldNumericOperatorEnum: + description: Allowed operators for `"operatorType":"numeric_operator"` + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + - assigned' + - not_assigned + example: numeric_lt + CustomFieldDateOperatorEnum: + description: Allowed operators for `"operatorType":"date_operator"` + type: string + enum: + - date_to + - date_from + - custom + - specific_date + - assigned + - not_assigned + example: date_to + CustomFieldValueForStringOperatorTypes: + description: >- + Any string, allowed only for `"operatorType":"string_operator"` and + `"operatorType":"string_operator_list"` + type: string + example: Canada + CustomFieldValueForNumericOperatorType: + description: Any number, allowed only for `"operatorType":"numeric_operator"` + type: string + example: '1' + CustomFieldValueForOperatorTypeDateAndOperatorSpecificDate: + description: >- + Allowed values for `"operatorType":"date_operator"` with + `"operator":"specific_date"` + type: string + enum: + - today + - yesterday + - last_7_days + - last_30_days + - last_n_days + - this_week + - last_week + - this_month + - last_month + - last_2_months + example: today + CustomFieldValueDateForOperatorTypeDateAndOperatorDateToOrDateFrom: + description: >- + Date string formatted as yyyy-mm-dd, allowed only for + `"operatorType":"date_operator"` with `"operator":"date_to"` or + `"operator":"date_from"` + allOf: + - $ref: '#/components/schemas/SpecificDateType' + CustomFieldValueDateTimeForOperatorTypeDateAndOperatorDateToOrDateFrom: + description: >- + Date time string compliant with ISO 8601, allowed only for + `"operatorType":"date_operator"` with `"operator":"date_to"` or + `"operator":"date_from"` + allOf: + - $ref: '#/components/schemas/SpecificDateTimeType' + CustomFieldValueForOperatorTypeDateAndOperatorCustom: + description: >- + Date interval string compliant with ISO 8601, supported format: + /, allowed only for + `"operatorType":"date_operator"` with `"operator":"custom"` + allOf: + - $ref: '#/components/schemas/IntervalDateType' + SubscriptionDateCondition: + description: Use this to find a contact by subscription date, use. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - date_operator + example: date_operator + operator: + type: string + enum: + - date_to + - date_from + - specific_date + - custom + value: + type: string + example: 2018-04-01/2018-04-30 + oneOf: + - allOf: + - $ref: '#/components/schemas/SpecificDateType' + - allOf: + - $ref: '#/components/schemas/SpecificDateTimeType' + - allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + - allOf: + - $ref: '#/components/schemas/IntervalDateType' + type: object + example: + conditionType: subscription_date + operatorType: date_operator + operator: custom + value: 2018-04-01/2018-04-30 + allOf: + - $ref: '#/components/schemas/ConditionType' + SubscriptionMethodCondition: + description: The subscription method. + required: + - method + properties: + method: + type: string + enum: + - webform + - import + - landing_page + - api + - email + - panel + - mobile + - forward + - survey + - sales + - copy + - leads + - webinar + webformType: + description: >- + The property required for the webform subscription method. If it + equals webforms, webformsv2 or popups, additonal property value is + needed. + type: string + enum: + - all + - webforms + - webformsv2 + - popups + value: + description: >- + The field required for `import`, `landing_page` and `webinar`, + optional for the `webform` method + type: string + oneOf: + - description: >- + If the method value equals `webform`, then the value is equal to + the webform, webformv2 or popup identifiers. The field is + required for the webformType={webforms, webformsv2, popups}. + example: PSO39 + - description: >- + If the method value equals `import`, then the value is equal to + the import identifier, or all for ‘all’ imports. + example: all + - description: >- + If the method value equals `landing_page`, then the value is + equal to the landing page identifier, or ‘all’ for all landing + pages + example: all + - description: >- + If the method value equals `webinar`, then the value is equal to + the webinar identifier, or ‘all’ for all webinars + example: all + type: object + allOf: + - $ref: '#/components/schemas/ConditionType' + OpenedCondition: + description: Search contacts who did open a message. + type: object + example: + conditionType: opened + operatorType: message_operator + operator: autoresponder + value: 'SGNLr:' + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionMessageOperator' + NotOpenedCondition: + description: Search contacts who didn't open a message. + required: + - operatorType + - operator + - dateOperator + properties: + operatorType: + type: string + enum: + - complex_message_operator + example: complex_message_operator + operator: + description: Specifies the type of message to search for + example: newsletter + oneOf: + - description: For all available message types + type: string + enum: + - all + example: all + - $ref: '#/components/schemas/MessageTypeOperator' + scope: + description: >- + The message identifier. Required only for the operator different + from 'all'. + type: string + example: z4Zje + dateOperator: + description: >- + It allows you to set a date range. For some of them `value` will be + required. Examples can be found here: [API + Docs](https://apidocs.getresponse.com/v3/case-study/segments-manual#not-opened-action). + type: string + enum: + - date_from + - never + - today + - yesterday + - last_7_days + - last_30_days + - last_n_days + - this_week + - this_month + value: + description: >- + This field is required only for `date_from` and `last_n_days` date + operators. + oneOf: + - description: >- + The date string compliant with ISO 8601. The value field is + required for the dateOperator equal to `date_from`. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: Number of days. Required for `last_n_days` date operator. + type: integer + example: 10 + includeCurrentPeriod: + description: >- + Flag determines if current day will be included into chosen range. + This flag can be used with `last_7_days`, `last_30_days`, + `last_n_days`. + type: boolean + example: true + type: object + example: + conditionType: not_opened + operatorType: complex_message_operator + scope: z4Zje + operator: autoresponder + dateOperator: never + allOf: + - $ref: '#/components/schemas/ConditionType' + AutoresponderDayCondition: + description: To find the autoresponder cycle day of a contact. + required: + - operatorType + - operator + properties: + operatorType: + type: string + enum: + - numeric_operator + operator: + type: string + oneOf: + - $ref: '#/components/schemas/RelationalNumericOperatorEnum' + - enum: + - assigned + - not_assigned + example: assigned + value: + description: >- + The autoresponder cycle day value. The field is prohibited for the + operators assigned and not_assigned. + type: integer + format: int32 + example: 6 + type: object + example: + conditionType: phase + operatorType: numeric_operator + operator: numeric_eq + value: 6 + allOf: + - $ref: '#/components/schemas/ConditionType' + LastSendDateCondition: + description: Search the last time when an email message was sent to a contact. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - date_operator + operator: + type: string + enum: + - date_to + - date_from + - specific_date + - custom + value: + type: string + example: last_7_days + oneOf: + - description: >- + For `date_to` or `date_from` operators. Date string is compliant + with ISO 8601. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: >- + For the operator=custom, it's the time interval compliant with + ISO 8601 + allOf: + - $ref: '#/components/schemas/IntervalDateType' + - description: For a specific_date operator + allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + type: object + example: + conditionType: last_send_date + operatorType: date_operator + operator: specific_date + value: last_7_days + allOf: + - $ref: '#/components/schemas/ConditionType' + LastClickDateCondition: + description: This is used to find the last time when a contact clicked a message. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - date_operator + example: date_operator + operator: + type: string + enum: + - date_to + - date_from + - specific_date + - custom + example: specific_date + value: + type: string + example: last_7_days + oneOf: + - description: >- + For `date_to` or `date_from` operators. Date string is compliant + with ISO 8601. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: >- + For the operator=custom, it's the time interval compliant with + ISO 8601 + allOf: + - $ref: '#/components/schemas/IntervalDateType' + - description: For the specific_date operator + allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + type: object + example: + conditionType: last_click_date + operatorType: date_operator + operator: specific_date + value: last_7_days + allOf: + - $ref: '#/components/schemas/ConditionType' + LastOpenDateCondition: + description: Search the last time when a contact opened a message. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - date_operator + example: date_operator + operator: + type: string + enum: + - date_to + - date_from + - specific_date + - custom + example: specific_date + value: + type: string + example: last_7_days + oneOf: + - description: >- + For `date_to` or `date_from` operators. Date string is compliant + with ISO 8601. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: >- + For the operator=custom, it's the time interval compliant with + ISO 8601 + allOf: + - $ref: '#/components/schemas/IntervalDateType' + - description: For the specific_date operator + allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + type: object + example: + conditionType: last_open_date + operatorType: date_operator + operator: specific_date + value: last_7_days + allOf: + - $ref: '#/components/schemas/ConditionType' + WebinarCondition: + description: >- + Search contacts that have participated/not participated in a specific + webinar as a host/listener/presenter/registrant/any user. + required: + - scope + - webinarCondition + - contactType + properties: + scope: + description: The identifier of a webinar + type: string + example: MNAR + webinarCondition: + type: string + enum: + - participated + - not_participated + example: participated + contactType: + type: string + enum: + - host + - listener + - presenter + - registrant + - all + example: presenter + type: object + example: + conditionType: webinar + scope: MNAR + webinarCondition: participated + contactType: presenter + allOf: + - $ref: '#/components/schemas/ConditionType' + LinkClickedCondition: + description: Search contacts that clicked on a link. + required: + - operatorType + - operator + - scope + - clickTrackId + properties: + operatorType: + type: string + enum: + - message_operator + example: message_operator + operator: + $ref: '#/components/schemas/MessageTypeOperator' + scope: + description: The message identifier + type: string + example: SGNLr + clickTrackId: + oneOf: + - type: string + enum: + - all + example: all + - description: The identifier of the clickTrackId + type: string + example: SGNLr + type: object + example: + conditionType: clicked + operatorType: message_operator + operator: autoresponder + scope: SGNLr + clickTrackId: all + allOf: + - $ref: '#/components/schemas/ConditionType' + LinkNotClickedCondition: + description: Search contacts that didn't click a link. + required: + - operatorType + - operator + - dateOperator + properties: + operatorType: + type: string + enum: + - complex_message_operator + example: complex_message_operator + operator: + example: newsletter + oneOf: + - description: For all available message types + type: string + enum: + - all + example: all + - $ref: '#/components/schemas/MessageTypeOperator' + dateOperator: + description: >- + It allows you to set a date range. For some of them `value` will be + required. Examples can be found here: [API + Docs](https://apidocs.getresponse.com/v3/case-study/segments-manual#not-opened-action). + enum: + - date_from + - never + - today + - yesterday + - last_7_days + - last_30_days + - last_n_days + - this_week + - this_month + example: today + value: + description: >- + This field is required only for `date_from` and `last_n_days` date + operators. + oneOf: + - description: >- + The date string compliant with ISO 8601. The value field is + required for the dateOperator equal to `date_from`. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: Number of days. Required for `last_n_days` date operator. + type: integer + example: 10 + includeCurrentPeriod: + description: >- + Flag determines if current day will be included into chosen range. + This flag can be used with `last_7_days`, `last_30_days`, + `last_n_days`. + type: boolean + example: true + scope: + description: >- + The message identifier. This field is prohibited for the 'all' + operator. + type: string + example: zhgnQ + clickTrackId: + description: The click track identifier + type: string + example: PPxiOW + oneOf: + - description: For all possible links in a message + enum: + - all + example: all + - description: For a specified click track ID + example: PPxiOW + type: object + example: + conditionType: not_clicked + operatorType: complex_message_operator + operator: newsletter + dateOperator: today + scope: zhgnQ + clickTrackId: all + allOf: + - $ref: '#/components/schemas/ConditionType' + MessageSentCondition: + description: Search contacts who received a certain message. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - message_operator + example: message_operator + operator: + $ref: '#/components/schemas/MessageTypeOperator' + value: + description: The message identifier + type: string + example: zSFIB + type: object + example: + conditionType: sent + operatorType: message_operator + operator: autoresponder + value: zSFIB + allOf: + - $ref: '#/components/schemas/ConditionType' + MessageNotSentCondition: + description: Search contacts who didn't receive a certain message. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - message_operator + example: message_operator + operator: + $ref: '#/components/schemas/MessageTypeOperator' + value: + description: The message identifier + type: string + example: z4Zje + type: object + example: + conditionType: not_sent + operatorType: message_operator + operator: autoresponder + value: z4Zje + allOf: + - $ref: '#/components/schemas/ConditionType' + ECommerceBrandPurchasedCondition: + description: Search contacts by brand purchased. + required: + - scope + - operatorType + - operator + - value + properties: + scope: + description: The shop identifier + type: string + example: ZTo + operatorType: + type: string + enum: + - equal_operator + example: equal_operator + operator: + type: string + enum: + - is + - not_is + example: is + value: + type: string + example: GetResponse + type: object + example: + conditionType: ecommerce_brand_purchased + scope: ZTo + operatorType: equal_operator + operator: is + value: GetResponse + allOf: + - $ref: '#/components/schemas/ConditionType' + ECommerceProductPurchasedCondition: + description: Search the product purchased. + required: + - shopScope + - categoryScope + - operatorType + - operator + - productScope + - dateOperator + properties: + shopScope: + description: Limit the searched shops + type: string + oneOf: + - description: For all available shops + enum: + - all + example: all + - description: The shop identifier + example: ZTo + categoryScope: + description: The product category + type: string + oneOf: + - description: For all available categories + enum: + - all + example: all + - description: The category identifier + example: PZ3 + operatorType: + type: string + enum: + - equal_operator + example: equal_operator + operator: + type: string + enum: + - is + - is_not + example: is + productScope: + type: string + oneOf: + - description: For all available products + enum: + - all + example: all + - description: For a specified product + example: oZt + dateOperator: + description: >- + Set a date range. For the date_from and date_to, custom field value + is required. + type: string + oneOf: + - description: >- + The field value is prohibited. The date string is compliant with + ISO 8601. + allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + - description: The field value is prohibited + enum: + - all_time + example: all_time + - description: The field value is required + enum: + - date_to + - date_from + - custom + value: + description: >- + This field stores the date or time interval for the date operators + date_to, date_from, or custom + type: string + example: '2018-04-01' + oneOf: + - description: >- + For the dateOperator date_to and date_from, it's the time + compliant with ISO 8601 + $ref: '#/components/schemas/SpecificDateType' + - description: >- + For the dateOperator=custom, it's the time interval compliant + with ISO 8601 + $ref: '#/components/schemas/IntervalDateType' + type: object + example: + conditionType: ecommerce_product_purchased + shopScope: all + categoryScope: all + operatorType: equal_operator + operator: is + productScope: all + dateOperator: date_from + value: '2018-04-01' + allOf: + - $ref: '#/components/schemas/ConditionType' + ECommerceTotalSpentCondition: + description: Search contacts by total spent. + required: + - operatorType + - operator + - scope + - value + - currency + properties: + operatorType: + type: string + enum: + - numeric_operator + example: numeric_operator + operator: + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_eq + scope: + description: The condition limiting the searched shop + type: string + example: Zto + oneOf: + - description: For all available shops + enum: + - all + example: all + - description: The shop identifier + example: ZTo + value: + type: number + format: double + example: '7.00' + currency: + description: The currency code according to ISO 4217, i.e. USD, GBP, PLN + type: string + example: USD + type: object + example: + conditionType: ecommerce_total_spent + scope: all + operatorType: numeric_operator + operator: numeric_eq + value: 7 + currency: USD + allOf: + - $ref: '#/components/schemas/ConditionType' + ECommerceNumberOfPurchasesCondition: + description: Search contacts by the number of purchases. + required: + - operatorType + - operator + - scope + - value + properties: + operatorType: + type: string + enum: + - numeric_operator + example: numeric_operator + operator: + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_eq + scope: + description: The condition limiting the searched shop + type: string + example: Zto + oneOf: + - description: For all available shops + enum: + - all + example: all + - description: The shop identifier + example: ZTo + value: + type: integer + format: int32 + example: 7 + type: object + example: + conditionType: ecommerce_number_of_purchases + scope: all + operatorType: numeric_operator + operator: numeric_eq + value: 7 + allOf: + - $ref: '#/components/schemas/ConditionType' + TagCondition: + description: Search contacts by tag. + required: + - operatorType + - operator + - value + properties: + operatorType: + description: The operator for the existence of a property + type: string + enum: + - exists + example: exists + operator: + description: >- + This operator verifies whether the property you are looking for + exists or not + type: string + enum: + - exists + - not_exists + example: exists + value: + description: The tag identifier + type: string + example: BB + type: object + example: + conditionType: tag + value: BB + operatorType: exists + operator: exists + allOf: + - $ref: '#/components/schemas/ConditionType' + ECommerceAbandonedCartCondition: + description: Search contacts by abandoned cart. + required: + - shopScope + - dateOperator + properties: + shopScope: + description: Limit the searched shops + type: string + oneOf: + - description: For all available shops + enum: + - all + example: all + - description: The shop identifier + example: ZTo + dateOperator: + description: >- + Set a date range. For the date_from and last_n_days, custom field + value is required. Examples can be found here: [API + Docs](https://apidocs.getresponse.com/v3/case-study/segments-manual/#ecommerce-abandoned-cart-condition-type). + type: string + enum: + - date_from + - anytime + - never + - today + - yesterday + - last_n_days + - this_week + - this_month + value: + description: >- + This field is required only for `date_from` and `last_n_days` date + operators. + oneOf: + - description: >- + The date string compliant with ISO 8601. The value field is + required for the dateOperator equal to `date_from`. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: Number of days. Required for `last_n_days` date operator. + type: integer + example: 10 + includeCurrentPeriod: + description: >- + Flag determines if current day will be included into chosen range. + This flag can be used with `last_n_days`. + type: boolean + example: true + type: object + example: + conditionType: ecommerce_abandoned_cart + shopScope: ZTo + dateOperator: date_from + value: '2018-04-01' + allOf: + - $ref: '#/components/schemas/ConditionType' + SmsSentCondition: + description: Find contacts who were sent an SMS + required: + - smsId + properties: + smsId: + description: The SMS message ID + type: string + example: ZTo + type: object + example: + conditionType: sms_sent + smsId: ZTo + allOf: + - $ref: '#/components/schemas/ConditionType' + SmsDeliveredCondition: + description: Find contacts who received an SMS + required: + - smsId + properties: + smsId: + description: The SMS message ID + type: string + example: ZTo + type: object + example: + conditionType: sms_delivered + smsId: ZTo + allOf: + - $ref: '#/components/schemas/ConditionType' + SmsLinkClickedCondition: + description: Find contacts who clicked a link from an SMS + required: + - smsId + - clickTrackId + properties: + smsId: + description: The SMS message ID + type: string + example: ZTo + clickTrackId: + description: The click track ID + type: string + example: ABc + type: object + example: + conditionType: sms_link_clicked + smsId: ZTo + clickTrackId: ABc + allOf: + - $ref: '#/components/schemas/ConditionType' + SmsLinkNotClickedCondition: + description: Find contacts who didn't click a link from an SMS + required: + - smsId + - clickTrackId + properties: + smsId: + description: The SMS message ID + type: string + example: ZTo + clickTrackId: + description: The click track ID + type: string + example: ABc + type: object + example: + conditionType: sms_link_not_clicked + smsId: ZTo + clickTrackId: ABc + allOf: + - $ref: '#/components/schemas/ConditionType' + ScoringCondition: + description: Search contacts by scoring. + required: + - operatorType + properties: + operatorType: + type: string + enum: + - numeric_operator + - not_exists + example: numeric_operator + operator: + description: >- + The relational operator. Required for the + operatorType=numeric_operator. + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_lt + value: + description: >- + This field is required for the relational operator, and prohibited + for the not_exists operator type + type: integer + format: int32 + example: 5 + type: object + example: + conditionType: score + operatorType: numeric_operator + operator: numeric_lt + value: 5 + allOf: + - $ref: '#/components/schemas/ConditionType' + EngagementScoreCondition: + description: Search contacts by their engagement score + required: + - operator + - value + properties: + operatorType: + type: string + enum: + - numeric_operator + example: numeric_operator + operator: + description: The operator used in engagement score comparison + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_lt + value: + description: The condition value + type: integer + format: int32 + example: 5 + type: object + example: + conditionType: engagement_score + operatorType: numeric_operator + operator: numeric_lt + value: 5 + allOf: + - $ref: '#/components/schemas/ConditionType' + GeolocationCondition: + description: Search contacts by geolocation. + required: + - operatorType + - operator + - value + - scope + properties: + scope: + description: Specify the search parameters + type: string + enum: + - country + - country_code + - region + - city + - longitude + - latitude + - postal_code + - dma_code + example: city + type: object + example: + conditionType: geo + operatorType: string_operator + operator: starts + value: New + scope: city + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionStringOperator' + CrmCondition: + description: This makes it possible to search contacts by CRM conditions. + required: + - pipelineScope + - stageScope + properties: + pipelineScope: + description: The pipeline identifier + type: string + example: PSVq + stageScope: + description: '' + type: string + example: ZAHB + oneOf: + - description: For all available stages + enum: + - all + example: all + - description: The stage identifier + example: ZAHB + type: object + example: + conditionType: crm + pipelineScope: PSVq + stageScope: ZAHB + allOf: + - $ref: '#/components/schemas/ConditionType' + GoalCondition: + description: Search contacts by a defined goal. + required: + - operatorType + - operator + - scope + properties: + operatorType: + type: string + enum: + - numeric_operator + example: numeric_operator + operator: + description: >- + The relational and existence operator. For the relational operator, + the value field is required. + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + - assigned + - not_assigned + example: numeric_lt + value: + description: >- + The value to be compared for the relational operator. For the + assigned, the not_assigned operator field is prohibited. + type: integer + format: int32 + example: 5 + scope: + description: The goal identifier + type: string + example: p22 + type: object + example: + conditionType: goal + operatorType: numeric_operator + operator: numeric_lt + value: '5' + scope: p22 + allOf: + - $ref: '#/components/schemas/ConditionType' + CustomEventCondition: + description: Search contacts for which an custom event occurred / not occurred + required: + - customEventId + - occurrence + - dateOperator + properties: + customEventId: + description: The custom event identifier + type: string + example: PNM + occurrence: + description: Whether the custom event occurred or not + type: string + enum: + - occurred + - not_occurred + example: occurred + dateOperator: + description: >- + Show contacts for which a custom event occurred / not occurred in + certain date range + type: string + oneOf: + - allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + - description: Anytime + enum: + - anytime + example: anytime + - description: >- + Allows you to choose a custom date range. The `date` field must + be set to use this operator. + enum: + - date_to + - date_from + - custom + date: + description: >- + The operators `date_to`, `date_from`, and `customDate` require you + to provide, respectively, a date, datetime, or a time interval. + type: string + example: '2018-04-01' + oneOf: + - $ref: '#/components/schemas/SpecificDateType' + - $ref: '#/components/schemas/SpecificDateTimeType' + - $ref: '#/components/schemas/IntervalDateType' + type: object + example: + conditionType: custom_event + customEventId: PNM + occurrence: occurred + dateOperator: date_from + value: '2018-04-01' + allOf: + - $ref: '#/components/schemas/ConditionType' + CreateTransactionalEmail: + required: + - fromField + - subject + - recipients + - contentType + properties: + fromField: + description: The 'From' address ID to be used as the message sender + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The 'From' address ID to be used as the Reply-to + allOf: + - $ref: '#/components/schemas/FromFieldReference' + tag: + description: The tag ID used for statistical data collection + allOf: + - $ref: '#/components/schemas/NewTransactionalEmailTag' + recipients: + $ref: '#/components/schemas/TransactionalEmailRecipients' + contentType: + description: The message content type + type: string + default: direct + enum: + - direct + - template + type: object + discriminator: + propertyName: contentType + mapping: + direct: '#/components/schemas/DirectContent' + template: '#/components/schemas/TemplateContent' + DirectContent: + type: object + allOf: + - $ref: '#/components/schemas/CreateTransactionalEmail' + - $ref: '#/components/schemas/TransactionalEmailContent' + TemplateContent: + type: object + allOf: + - $ref: '#/components/schemas/CreateTransactionalEmail' + - $ref: '#/components/schemas/TransactionalEmailTemplate' + NewTransactionalEmailTag: + required: + - tagId + properties: + tagId: + type: string + example: vBd5 + type: object + TransactionalEmailContent: + required: + - content + properties: + subject: + type: string + maxLength: 512 + minLength: 1 + example: Order Confirmation - Example Shop + attachments: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailAttachment' + content: + description: >- + The message content. At least one field is required. The maximum + combined size of plain text and HTML is 16MB + properties: + plain: + type: string + example: Your order has been confirmed. Thank you for shopping with us! + html: + type: string + example: >- +

Your order has been confirmed

Thank you for + shopping with us! + type: object + type: object + TransactionalEmailTemplate: + description: The template content + required: + - template + properties: + template: + description: The message template. At least templateId is required + required: + - templateId + properties: + templateId: + description: Transactional emails template identifier + type: string + example: Ykz + lexpad: + description: Transactional email lexpad + type: object + example: + some-key: some-value + type: object + type: object + TransactionalEmailRecipients: + required: + - to + properties: + to: + $ref: '#/components/schemas/TransactionalEmailRecipientTo' + cc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipient' + bcc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipient' + type: object + TransactionalEmailRecipientTo: + required: + - email + properties: + validSince: + description: The first time this address appeared in your system + type: string + format: date-time + example: 2018-05-02T09:30:43+0200 + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipient' + TransactionalEmailRecipient: + required: + - email + properties: + email: + type: string + format: email + example: john.doe@example.com + name: + type: string + maxLength: 128 + minLength: 1 + example: John Doe + status: + type: string + enum: + - unknown + - sent + - rejected + - opened + - bounced + - reported_spam + readOnly: true + type: object + TransactionalEmailAttachment: + required: + - fileName + - content + - mimeType + properties: + fileName: + type: string + maxLength: 128 + minLength: 3 + example: pixel.png + mimeType: + description: The MIME attachment type + type: string + maxLength: 128 + minLength: 3 + example: image/png + content: + description: The base64-encoded attachment + type: string + format: base64 + example: >- + iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mOUua1dDwAD4AGjnrXmUAAAAABJRU5ErkJggg== + type: object + TransactionalEmailsTemplateDetails: + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmailsTemplateListElement' + - properties: + content: + $ref: '#/components/schemas/TransactionalEmailTemplateContent' + type: object + TransactionalEmailsTemplateListElement: + properties: + templateId: + description: Transactional email template ID + type: string + readOnly: true + example: p + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api3.getresponse360.com/v3/transactional-emails/templates/tRe4i + subject: + description: The template subject + type: string + example: Order Confirmation Template + createdOn: + description: The creation date + type: string + format: date-time + updatedOn: + description: The date of the last template update + type: string + format: date-time + editor: + description: The Editor type + allOf: + - type: string + enum: + - html + - wysiwyg + type: object + CreateTransactionalEmailTemplate: + required: + - subject + properties: + subject: + description: The template subject + type: string + example: Order Confirmation - Example Shop + content: + $ref: '#/components/schemas/TransactionalEmailTemplateContent' + type: object + TransactionalEmailTemplateContent: + description: The template content. At least one field is required + properties: + plain: + description: The plain text equivalent of template content + type: string + example: Your order has been confirmed. Thank you for shopping with us! + html: + description: The template content in HTML + type: string + example: >- +

Your order has been confirmed

Thank you for shopping + with us! + type: object + TransactionalEmailRecipientStatuses: + properties: + rejectedOn: + type: string + format: date-time + readOnly: true + example: null + nullable: true + openedOn: + type: string + format: date-time + readOnly: true + example: 2019-06-02T09:30:43+0200 + nullable: true + bouncedOn: + type: string + format: date-time + readOnly: true + example: null + nullable: true + complainedOn: + type: string + format: date-time + readOnly: true + example: null + nullable: true + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipientSentOnStatus' + TransactionalEmailRecipientClickedLink: + properties: + url: + type: string + format: uri + readOnly: true + example: https://example.com + clickedOn: + type: string + format: date-time + readOnly: true + example: 2019-06-02T09:31:20+0200 + type: object + TransactionalEmailRecipientDetails: + properties: + statuses: + $ref: '#/components/schemas/TransactionalEmailRecipientStatuses' + clickedLinks: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipientClickedLink' + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipient' + TransactionalEmailRecipientsDetails: + required: + - to + properties: + to: + $ref: '#/components/schemas/TransactionalEmailRecipientDetails' + cc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipientDetails' + bcc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipientDetails' + type: object + TransactionalEmailDetails: + required: + - transactionalEmailId + - fromField + - subject + - recipients + properties: + fromField: + description: The 'From' address ID to be used as the message sender + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The 'From' address ID to be used as the Reply-to + allOf: + - $ref: '#/components/schemas/FromFieldReference' + subject: + type: string + maxLength: 512 + minLength: 1 + example: Order Confirmation - Example Shop + tag: + description: The tag ID used for statistical data collection + allOf: + - $ref: '#/components/schemas/TransactionalEmailTag' + recipients: + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipientsDetails' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api3.getresponse360.com/v3/transactional-emails/tRe4i + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmail' + TransactionalEmailTag: + required: + - tagId + properties: + tagId: + type: string + example: vBd5 + type: object + TransactionalEmailRecipientSentOnStatus: + properties: + sentOn: + type: string + format: date-time + readOnly: true + example: 2019-06-02T09:30:43+0200 + nullable: true + type: object + TransactionalEmailListElement: + required: + - transactionalEmailId + - recipients + - fromField + - subject + properties: + transactionalEmailId: + type: string + readOnly: true + example: tRe4i + fromField: + $ref: '#/components/schemas/FromFieldReference' + recipients: + allOf: + - required: + - to + properties: + to: + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipient' + - properties: + statuses: + $ref: >- + #/components/schemas/TransactionalEmailRecipientSentOnStatus + type: object + type: object + subject: + type: string + maxLength: 512 + minLength: 1 + example: Order Confirmation - Example Shop + tag: + $ref: '#/components/schemas/TransactionalEmailTag' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api3.getresponse360.com/v3/transactional-emails/tRe4i + type: object + TransactionalEmailStatistics: + properties: + timeFrame: + description: >- + The statistics time frame in the ISO 8601 date format with duration + interval + type: string + pattern: >- + /^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?(\/)P(?=\w*\d)(?:\d+Y|Y)?(?:\d+M|M)?(?:\d+W|W)?(?:\d+D|D)?(?:T(?:\d+H|H)?(?:\d+M|M)?(?:\d+(?:\­.\d{1,2})?S|S)?)?$/ + example: 2014-09-20T00:00:00+0000/P2M18DT10H0M0S + sent: + type: integer + format: int64 + opened: + type: integer + format: int64 + bounced: + type: integer + format: int64 + complaint: + type: integer + format: int64 + type: object + TransactionalEmail: + properties: + transactionalEmailId: + type: string + readOnly: true + example: tRe4i + type: object + FromField: + properties: + fromFieldId: + description: The 'From' address ID + type: string + readOnly: true + example: TTzW + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/TTzW + email: + description: The email address + type: string + format: email + example: jsmith@example.com + rewrittenEmail: + description: Email address used to send message. + type: string + format: email + example: jsmith@example.com + nullable: true + name: + description: The name connected to the email address + type: string + maxLength: 64 + minLength: 2 + example: John Smith + isActive: + description: Flag if the 'From' address is active + readOnly: true + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + isDefault: + description: Flag if the 'From' address is default for the account + readOnly: true + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + domain: + properties: + status: + description: Status of domain + type: string + enum: + - confirmed + - unconfirmed + - deleted + - can_not_be_used + - dns_configuration_pending + nullable: true + DKIMWarning: + description: DKIM warning status + type: string + enum: + - not_recommended + - can_not_be_used + - not_authenticated + - at_risk + nullable: true + type: object + type: object + NewFromField: + required: + - email + - name + type: object + allOf: + - $ref: '#/components/schemas/FromField' + FromFieldReference: + required: + - fromFieldId + properties: + fromFieldId: + description: The 'From' address ID + type: string + example: V + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/V + type: object + RssNewsletterDetails: + properties: + clickTracks: + description: The list of tracked links + type: array + items: + $ref: '#/components/schemas/ClickTrack' + flags: + $ref: '#/components/schemas/MessageFlagsArray' + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletter' + RssNewsletterListItem: + properties: + flags: + $ref: '#/components/schemas/MessageFlagsString' + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterListing' + RssNewsletterSendSettingsListing: + required: + - frequency + - filter + properties: + frequency: + description: When to send the message + type: string + example: asap + filter: + description: The filter settings for an RSS post + type: string + enum: + - recent + - engaged + - shared + - commented + maxArticles: + description: How many articles to display in a list + type: integer + format: int32 + maximum: 30 + minimum: 1 + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSuppressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + discriminator: + propertyName: frequency + mapping: + asap: '#/components/schemas/RssNewsletterListSendAsapSettings' + daily: '#/components/schemas/RssNewsletterListSendDailySettings' + weekly: '#/components/schemas/RssNewsletterListSendWeeklySettings' + monthly: '#/components/schemas/RssNewsletterListSendMonthlySettings' + RssNewsletterListSendAsapSettings: + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + RssNewsletterListSendDailySettings: + required: + - sendAtHour + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + RssNewsletterListSendWeeklySettings: + required: + - sendAtHour + - sendAtWeekDay + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + sendAtWeekDay: + description: The day of the week when the message should be sent + type: string + enum: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + RssNewsletterListSendMonthlySettings: + required: + - sendAtHour + - sendAtMonthDay + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + minimum: 0 + sendAtMonthDay: + description: >- + The day of the month when the message should be sent or 31 + representing last day of month + type: integer + format: int32 + maximum: 28 + minimum: 1 + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + RssNewsletterListing: + required: + - rssNewsletterId + - href + properties: + rssNewsletterId: + description: The RSS newsletter ID + type: string + readOnly: true + example: dGer + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/rss-newsletters/dGer + rssFeedUrl: + description: The URL for the RSS Feed + type: string + format: uri + example: http://blog.getresponse.com + subject: + description: The RSS message subject + type: string + maxLength: 255 + minLength: 1 + example: My rss to newsletters + name: + description: How your newsletters will be seen inside the application + type: string + maxLength: 255 + minLength: 1 + example: rsstest0 + status: + description: The status of the RSS newsletter + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + editor: + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + fromField: + description: The 'From' email address used for the message + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The email that will be used as a reply-to address + allOf: + - $ref: '#/components/schemas/FromFieldReference' + content: + $ref: '#/components/schemas/MessageContent' + sendSettings: + description: How the message will be delivered to the subscriber + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + MessageSendSettingSelectedCampaigns: + description: The list of campaign IDs to choose subscribers from. + items: + type: string + example: C + MessageSendSettingSelectedSegments: + description: The list of segment IDs to choose subscribers from. + items: + type: string + example: Se + MessageSendSettingSelectedSuppressions: + description: The list of suppression IDs to exclude subscribers. + items: + type: string + example: Ss + MessageSendSettingExcludedCampaigns: + description: The list of campaign IDs to exclude subscribers. + items: + type: string + example: eC + MessageSendSettingExcludedSegments: + description: The list of segment IDs to exclude subscribers. + items: + type: string + example: eSs + MessageSendSettingSelectedContacts: + description: The list of selected contacts. + items: + type: string + example: eSs + BaseCampaign: + properties: + campaignId: + description: Campaign ID + type: string + readOnly: true + example: V3J + name: + description: >- + The campaign (list) name. + + + * You can use each list name just once in your account. + + + * The name must be between 3-64 characters. + + + * All alphabets supported by GetResponse, including right-to-left + ones, are allowed. + + + * You can use upper and lower case letters, numbers, spaces and + special characters apart from the ones listed below. + + + * You can’t use emojis and the following special characters: `/`, + `\`, `@`, and `[` or `]`. + type: string + maxLength: 64 + minLength: 3 + example: my_campaign + techName: + description: >- + Tech name is a unique internal ID of a list used for [FTP + imports](https://www.getresponse.com/help/how-to-import-files-via-ftp.html) + (available in GetResponse MAX accounts only) + type: string + readOnly: true + example: my_campaign + languageCode: + description: >- + The campaign language code according to ISO 639-1, plus: zt - + Chinese (Traditional), fs - Afghan Persian (Dari), md - Moldavian + type: string + example: EN + isDefault: + description: Is the campaign default + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + createdOn: + description: The date of creation + type: string + format: date-time + readOnly: true + example: 2014-02-12T15:19:21+0000 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/campaigns/V3J + type: object + CampaignAdditionalProperties: + properties: + postal: + $ref: '#/components/schemas/CampaignPostal' + confirmation: + $ref: '#/components/schemas/CampaignConfirmation' + optinTypes: + $ref: '#/components/schemas/CampaignOptinTypes' + subscriptionNotifications: + $ref: '#/components/schemas/CampaignSubscriptionNotifications' + profile: + $ref: '#/components/schemas/CampaignProfile' + type: object + Campaign: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseCampaign' + - $ref: '#/components/schemas/CampaignAdditionalProperties' + NewCampaign: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/Campaign' + UpdateCampaign: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/Campaign' + CampaignConfirmation: + properties: + fromField: + $ref: '#/components/schemas/FromFieldReference' + redirectType: + description: >- + What will happen after email confirmation. The values allowed + include: hosted (the subscriber will stay on the default GetResponse + website), customUrl (the subscriber will be redirected to a custom + URL provided by the user). + type: string + enum: + - hosted + - customUrl + example: hosted + mimeType: + description: The MIME type for the confirmation message + type: string + enum: + - text/html + - text/plain + - combo + example: text/plain + redirectUrl: + description: >- + Required if the redirectType is customUrl. The URL a subscriber will + be redirected to if the redirectType is set to customUrl. + type: string + format: uri + example: http://example.com + replyTo: + $ref: '#/components/schemas/FromFieldReference' + subscriptionConfirmationBodyId: + description: The subscription confirmation body ID + type: string + example: asS1 + subscriptionConfirmationSubjectId: + description: Subscription confirmation subject ID + type: string + example: TEww + type: object + CampaignOptinTypes: + properties: + email: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + - double + example: single + api: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + - double + example: single + import: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + example: single + webform: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + - double + example: single + type: object + CampaignPostal: + properties: + addPostalToMessages: + description: >- + Should the postal address be included in all message footers for + this campaign (mandatory for Canada and the US) + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + city: + description: The city, free-text + type: string + example: London + companyName: + description: The company name, free-text + type: string + example: Company Ltd. + country: + description: The country name, free-text + type: string + example: Great Britain + design: + description: >- + How the postal address will display in messages. The available + fields include: [[name]], [[address]], [[city]], [[state]] [[zip]], + [[country]] + type: string + example: '[[name]] from [[city]] in [[country]]' + state: + description: The state, free-text + type: string + example: Shire + street: + description: The street, free-text + type: string + example: Bilbo Baggins Av + zipCode: + description: The ZIP code + type: string + example: 81-611 + type: object + CampaignProfile: + properties: + description: + description: The campaign description + type: string + maxLength: 255 + minLength: 2 + example: campaign description + industryTagId: + description: The industry tag ID + type: string + format: integer + example: '1' + logo: + description: The logo URL + type: string + format: uri + example: http://logos.com/imageupdated.jpg + logoLinkUrl: + description: The logo link URL + type: string + format: uri + example: http://somePageLogoLinkUpdated.com + title: + description: The profile title + type: string + maxLength: 64 + minLength: 2 + example: title + type: object + CampaignSubscriptionNotifications: + properties: + status: + description: >- + Are notifications enabled. Possible values include: enabled, + disabled. + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + recipients: + type: array + items: + $ref: '#/components/schemas/FromFieldReference' + type: object + UpdateAccount: + type: object + allOf: + - $ref: '#/components/schemas/Account' + Account: + properties: + accountId: + description: Account ID + type: string + readOnly: true + example: VfEy1 + email: + description: Email + type: string + format: email + readOnly: true + example: john.smith@test.com + countryCode: + readOnly: true + $ref: '#/components/schemas/AccountDetailsCountryCode' + industryTag: + readOnly: true + $ref: '#/components/schemas/IndustryTagId' + timeZone: + readOnly: true + allOf: + - $ref: '#/components/schemas/TimezoneName' + - $ref: '#/components/schemas/TimezoneOffset' + href: + description: Direct URL to resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/accounts + firstName: + description: First name + type: string + maxLength: 64 + minLength: 2 + example: John + lastName: + description: Last name + type: string + maxLength: 64 + minLength: 2 + example: Smith + companyName: + description: Company name + type: string + maxLength: 64 + minLength: 2 + example: MyBigCompany + phone: + description: Phone number + type: string + maxLength: 32 + minLength: 2 + example: '+00155555555' + state: + description: State + type: string + maxLength: 40 + minLength: 2 + example: Oklahoma + city: + description: City + type: string + example: Alderson + street: + description: Street + type: string + maxLength: 64 + minLength: 2 + example: Sunset blv. + zipCode: + description: ZIP Code + type: string + maxLength: 9 + minLength: 2 + example: 81-611 + numberOfEmployees: + description: Numbers of employees + type: string + enum: + - '50' + - '250' + - '500' + - more + example: '500' + timeFormat: + description: Account time notation + type: string + enum: + - 12h + - 24h + example: 24h + type: object + AutoresponderTriggerSettings: + required: + - type + - dayOfCycle + - selectedCampaigns + properties: + type: + description: The trigger type + type: string + items: + type: string + enum: + - onday + default: onday + dayOfCycle: + description: >- + For onday type the day of the autoresponder cycle in the 0-9999 + format + type: integer + format: int32 + maximum: 9999 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + autoresponder: + type: string + readOnly: true + nullable: true + newsletter: + type: string + readOnly: true + nullable: true + clickTrackId: + type: string + readOnly: true + nullable: true + goal: + type: string + readOnly: true + nullable: true + custom: + type: string + readOnly: true + nullable: true + newCustomValue: + type: string + readOnly: true + nullable: true + action: + type: string + readOnly: true + nullable: true + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + type: object + AutoresponderSendSettings: + required: + - type + properties: + type: + description: When to send the message + type: string + enum: + - signup + - immediately + - delay + - custom + delayInHours: + description: >- + How many hours to delay the message after a trigger occured, in the + 0-23 format + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + sendAtHour: + description: >- + The specific hour on which the message will be sent, in the 0-23 + format + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + recurrence: + description: >- + Should the message be sent every time the trigger occurs (example: + each click) + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + timeTravel: + description: >- + Should the message be sent in the user's or the subscriber's time + zone + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + excludedDaysOfWeek: + description: >- + The days of the week to exclude from message sending (the message + will be sent on the next non-excluded day after the trigger) + type: array + items: + type: string + enum: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + externalLexpad: + description: >- + External Lexpad settings for the message, read more: [External + Lexpad](https://apidocs.getresponse.com/v3/dynamic-content/external-lexpad) + nullable: true + allOf: + - $ref: '#/components/schemas/ExternalLexpad' + type: object + discriminator: + propertyName: type + mapping: + signup: '#/components/schemas/AutoresponderSendSignupSettings' + immediately: '#/components/schemas/AutoresponderSendImmediatelySettings' + delay: '#/components/schemas/AutoresponderSendDelaySettings' + custom: '#/components/schemas/AutoresponderSendCustomSettings' + AutoresponderSendSignupSettings: + type: object + allOf: + - $ref: '#/components/schemas/AutoresponderSendSettings' + AutoresponderSendImmediatelySettings: + type: object + allOf: + - $ref: '#/components/schemas/AutoresponderSendSettings' + AutoresponderSendDelaySettings: + required: + - delayInHours + type: object + allOf: + - $ref: '#/components/schemas/AutoresponderSendSettings' + AutoresponderSendCustomSettings: + required: + - sendAtHour + type: object + allOf: + - $ref: '#/components/schemas/AutoresponderSendSettings' + Autoresponder: + required: + - autoresponderId + - href + properties: + autoresponderId: + description: The autoresponder ID + type: string + readOnly: true + example: Q + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/autoresponders/Q + name: + description: The autoresponder name + type: string + maxLength: 128 + minLength: 2 + example: Message 2 + subject: + description: The autoresponder message subject + type: string + maxLength: 128 + minLength: 2 + example: test12 + campaignId: + description: >- + The campaign ID. The system will assign the autoresponder to a + default campaign if you don't provide a specific campaign ID. + type: string + example: V + status: + description: The autoresponder status + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + editor: + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + fromField: + description: The from email address used for the message + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The email that will be used as a reply-to address + allOf: + - $ref: '#/components/schemas/FromFieldReference' + content: + $ref: '#/components/schemas/MessageContent' + flags: + $ref: '#/components/schemas/MessageFlagsArray' + sendSettings: + description: How the message will be delivered to the subscriber + allOf: + - $ref: '#/components/schemas/AutoresponderSendSettings' + triggerSettings: + description: 'The conditions that will trigger the autoresponder ' + allOf: + - $ref: '#/components/schemas/AutoresponderTriggerSettings' + statistics: + description: The autoresponder statistics summary + type: object + readOnly: true + allOf: + - properties: + delivered: + type: number + format: float + example: '0' + openRate: + type: number + format: float + example: '0' + clickRate: + type: number + format: float + example: '0' + type: object + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + NewAutoresponder: + required: + - status + - subject + - content + - sendSettings + - triggerSettings + type: object + allOf: + - $ref: '#/components/schemas/Autoresponder' + UpdateAutoresponder: + type: object + allOf: + - $ref: '#/components/schemas/Autoresponder' + RssNewsletterSendSettingsDetails: + required: + - frequency + - filter + properties: + frequency: + description: When to send the message + type: string + example: asap + filter: + description: The filter settings for an RSS post + type: string + enum: + - recent + - engaged + - shared + - commented + maxArticles: + description: How many articles to display in a list + type: integer + format: int32 + maximum: 30 + exclusiveMaximum: false + minimum: 1 + exclusiveMinimum: false + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSuppressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + selectedContacts: + $ref: '#/components/schemas/MessageSendSettingSelectedContacts' + type: object + discriminator: + propertyName: frequency + mapping: + asap: '#/components/schemas/RssNewsletterSendAsapSettings' + daily: '#/components/schemas/RssNewsletterSendDailySettings' + weekly: '#/components/schemas/RssNewsletterSendWeeklySettings' + monthly: '#/components/schemas/RssNewsletterSendMonthlySettings' + RssNewsletterSendAsapSettings: + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + RssNewsletterSendDailySettings: + required: + - sendAtHour + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + RssNewsletterSendWeeklySettings: + required: + - sendAtHour + - sendAtWeekDay + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + sendAtWeekDay: + description: The day of the week when the message should be sent + type: string + enum: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + RssNewsletterSendMonthlySettings: + required: + - sendAtHour + - sendAtMonthDay + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + sendAtMonthDay: + description: >- + The day of the month when the message should be sent or 31 + representing last day of month + type: integer + format: int32 + oneOf: + - description: Days available for every month + maximum: 28 + minimum: 1 + - description: >- + Represents the last day of month, even if it has less then 31 + days + enum: + - 31 + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + RssNewsletter: + required: + - rssNewsletterId + - href + properties: + rssNewsletterId: + description: The RSS newsletter ID + type: string + readOnly: true + example: dGer + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/rss-newsletters/dGer + rssFeedUrl: + description: The URL for the RSS Feed + type: string + format: uri + example: http://blog.getresponse.com + subject: + description: The RSS message subject + type: string + maxLength: 255 + minLength: 1 + example: My rss to newsletters + name: + description: How your newsletters will be seen inside the application + type: string + maxLength: 255 + minLength: 1 + example: rsstest0 + status: + description: The status of the RSS newsletter + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + editor: + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + fromField: + description: The 'From' email address used for the message + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The email that will be used as a reply-to address + allOf: + - $ref: '#/components/schemas/FromFieldReference' + content: + $ref: '#/components/schemas/MessageContent' + sendSettings: + description: How the message will be delivered to the subscriber + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + NewRssNewsletter: + required: + - rssFeedUrl + - subject + - status + - fromField + - content + - sendSettings + properties: + flags: + $ref: '#/components/schemas/MessageFlagsArray' + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletter' + UpdateRssNewsletter: + properties: + flags: + $ref: '#/components/schemas/MessageFlagsArray' + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletter' + MessageFlagsArray: + description: The message flags. + type: array + items: + type: string + enum: + - openrate + - clicktrack + - google_analytics + MessageFlagsString: + description: >- + Comma-separated list of message flags. The possible values are: + `openrate`, `clicktrack`, and `google_analytics`. + type: string + example: openrate,clicktrack,google_analytics + MessageEditorEnum: + description: >- + How the message was created: `custom` means a custom-made message, + `text` means plain text content, `getresponse` means that the message + was created using the GetResponse editor. + type: string + enum: + - custom + - text + - getresponse + - legacy + - html2 + MessageContent: + description: The message content. + properties: + html: + description: The message content in HTML + type: string + maxLength: 524288 + example: >- +

test 12

Some test http://example.com

+ plain: + description: The plain text equivalent of the message content + type: string + maxLength: 524288 + example: test 12 Some test + type: object + Contact: + required: + - contactId + - href + - email + properties: + contactId: + type: string + readOnly: true + example: pV3r + name: + type: string + maxLength: 128 + minLength: 1 + example: John Doe + origin: + type: string + enum: + - import + - email + - www + - panel + - leads + - sale + - api + - forward + - survey + - iphone + - copy + - landing_page + - website_builder_elegant + readOnly: true + timeZone: + description: >- + The time zone of a contact, uses the time zone database format + (https://www.iana.org/time-zones) + type: string + readOnly: true + example: Europe/Warsaw + activities: + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/contacts/pV3r/activities + changedOn: + type: string + format: date-time + readOnly: true + example: 2017-12-19T13:11:48+0000 + createdOn: + type: string + format: date-time + readOnly: true + example: 2017-03-02T07:30:49+0000 + campaign: + type: object + $ref: '#/components/schemas/CampaignReference' + email: + type: string + format: email + example: john.doe@example.com + dayOfCycle: + description: >- + The day on which the contact is in the Autoresponder cycle. `null` + indicates the contacts is not in the cycle. + type: string + example: '42' + nullable: true + scoring: + description: Contact scoring, pass null to remove the score from a contact + type: number + example: 8 + nullable: true + engagementScore: + description: >- + Engagement Score is a feature that presents a visual estimate of a + contact's engagement with mailings. The score is based on the + contact's interactions with your e-mails. Via API, it's returned in + the form of numbers ranging from 1 (Not Engaged) to 5 (Highly + Engaged). + type: integer + format: int32 + maximum: 5 + minimum: 1 + readOnly: true + example: 3 + nullable: true + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/contacts/pV3r + type: object + NewContactCustomFieldValue: + required: + - customFieldId + - value + properties: + customFieldId: + description: Custom field ID + type: string + example: kL6Nh + value: + type: array + items: + type: string + example: 18-35 + type: object + NewContactTag: + required: + - tagId + properties: + tagId: + type: string + example: m7E2 + type: object + ContactTag: + properties: + tagId: + type: string + example: hR + name: + type: string + example: super_promo + href: + type: string + format: uri + example: https://api.getresponse.com/v3/tags/hR + color: + type: string + deprecated: true + type: object + NewContactTags: + properties: + tags: + type: array + items: + $ref: '#/components/schemas/NewContactTag' + type: object + NewContactCustomFieldValues: + properties: + customFieldValues: + type: array + items: + $ref: '#/components/schemas/NewContactCustomFieldValue' + type: object + NewContact: + required: + - email + - campaign + type: object + allOf: + - $ref: '#/components/schemas/Contact' + - properties: + ipAddress: + description: The contact's IP address. IPv4 and IPv6 formats are accepted. + example: 1.2.3.4 + oneOf: + - type: string + format: ipv4 + - type: string + format: ipv6 + type: object + - $ref: '#/components/schemas/NewContactTags' + - $ref: '#/components/schemas/NewContactCustomFieldValues' + UpsertContactCustomFields: + required: + - customFieldValues + type: object + allOf: + - $ref: '#/components/schemas/NewContactCustomFieldValues' + UpsertContactTags: + required: + - tags + type: object + allOf: + - $ref: '#/components/schemas/NewContactTags' + UpdateContact: + type: object + allOf: + - $ref: '#/components/schemas/Contact' + - properties: + note: + type: string + maxLength: 255 + minLength: 0 + nullable: true + type: object + - $ref: '#/components/schemas/NewContactTags' + - $ref: '#/components/schemas/NewContactCustomFieldValues' + CustomFieldTypeEnum: + type: string + enum: + - text + - textarea + - radio + - checkbox + - single_select + - multi_select + - number + - date + - datetime + - country + - currency + - phone + - gender + - ip + - url + CustomFieldFormatEnum: + type: string + enum: + - text + - textarea + - radio + - checkbox + - single_select + - multi_select + CustomField: + properties: + customFieldId: + description: Custom field ID + type: string + readOnly: true + example: pas + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/custom-fields/pas + name: + description: >- + The name of the custom field. It must meet the following + requirements: + * be unique + * use only lowercase letters, underscores and digits + * not be equal to one of the merge words used in messages, i.e. `name, email, twitter, facebook, buzz, myspace, linkedin, digg, googleplus, pinterest, responder, campaign, change`. + type: string + maxLength: 128 + minLength: 1 + example: office_phone_number + type: + description: |- + The custom field `type` accepts the following values: + * `text` - text input (doesn't require values in the `values` field, you can pass empty array) + * `textarea` - textarea input (does n't require values in the `values` field, you can pass empty array) + * `radio` - radio input (requires at least 2 values in the `values` field) + * `checkbox` - checkbox input (requires at least 2 values in the `values` field) + * `single_select` - single select input (requires at least 2 values in the `values` field) + * `multi_select` - multi select input (requires at least 2 values in the `values` field) + * `number` - text input for a numeric value (doesn't require values in the `values` field, you can pass empty array) + * `date` - text input for a date (doesn't require values in the `values` field, you can pass empty array) + * `datetime` - text input for date and time (doesn't require values in the `values` field, you can pass empty array) + * `country` - multi select input for a country (requires at least 2 country names in the `values` field) + * `currency` - multi select for a currency, allows all ISO 4217 currency codes (requires at least 2 currency codes in the `values` field) + * `phone` - text input for a phone number (doesn't require values in the `values` field, you can pass empty array) + * `gender` - radio input for gender (requires 2 values in the `values` field: `Male` and `Female`, that can be translated into one of the languages supported by GetResponse) + * `ip` - text input for an IP address (doesn't require values in the `values` field, you can pass empty array) + * `url` - text input for a URL (doesn't require values in the `values` field, you can pass empty array). + example: phone + allOf: + - $ref: '#/components/schemas/CustomFieldTypeEnum' + valueType: + description: >- + Type of returning value, it returns `format` options extended by a + `string` option if the `format` was not defined + type: string + enum: + - string + - number + - date + - datetime + - country + - currency + - phone + - gender + - ip + - url + readOnly: true + example: phone + format: + description: |- + The custom field `format` accepts following values: + * `text` - text input (doesn't require values in the `values` field, you can pass empty array) + * `textarea` - textarea input (doesn't require values in the `values` field, you can pass empty array) + * `radio` - radio input (requires at least 2 values in the `values` field) + * `checkbox` - checkbox input (requires at least 2 values in the `values` field) + * `single_select` - single select input (requires at least 2 values in the `values` field) + * `multi_select` - multi select input (requires at least 2 values in the `values` field). + example: text + allOf: + - $ref: '#/components/schemas/CustomFieldFormatEnum' + fieldType: + description: Returns the same data as `type` + type: string + readOnly: true + example: text + deprecated: true + hidden: + description: Whether the custom field is visible to contacts + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + values: + description: >- + The list of assigned values (zero or more - depending on the custom + field type. Please see description) + type: array + items: + type: string + example: '+48600100200' + type: object + NewCustomField: + required: + - name + - type + - hidden + - values + type: object + allOf: + - $ref: '#/components/schemas/CustomField' + UpdateCustomField: + required: + - hidden + - values + properties: + hidden: + description: Whether the custom field is visible to contacts + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + values: + description: >- + The list of assigned values (zero or more - depending on the custom + field type. Please see description) + type: array + items: + type: string + example: '+48600100200' + type: object + NewSuppression: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseSuppression' + UpdateSuppression: + required: + - name + - masks + type: object + allOf: + - $ref: '#/components/schemas/BaseSuppression' + NewPredefinedField: + required: + - name + - value + - campaign + type: object + allOf: + - $ref: '#/components/schemas/PredefinedField' + UpdatePredefinedField: + required: + - value + properties: + value: + type: string + maxLength: 350 + minLength: 1 + pattern: ^[A-Za-z_]{1,350}$ + example: my_new_value + type: object + UpdateCallbacks: + properties: + url: + description: >- + URL to use to post notifications, required if callbacks are not yet + enabled + type: string + format: uri + example: https://example.com/callback + actions: + type: object + $ref: '#/components/schemas/CallbackActions' + type: object + TriggerCustomEvent: + required: + - name + - contactId + properties: + name: + description: >- + The name of custom event. Custom event with this name must already + exist + type: string + maxLength: 64 + minLength: 3 + pattern: ^[a-z0-9_]{3,64}$ + example: lesson_finished + contactId: + description: The contact ID + type: string + example: lTgH5 + attributes: + description: The attributes for the trigger + type: array + items: + $ref: '#/components/schemas/TriggerCustomEventAttribute' + type: object + TriggerCustomEventAttribute: + required: + - name + - value + properties: + name: + description: >- + The name of the attribute. It must be already defined for the custom + event + type: string + maxLength: 64 + minLength: 3 + example: lesson_name + value: + example: lesson_3 + $ref: '#/components/schemas/TriggerCustomEventAttributeValue' + type: object + TriggerCustomEventAttributeValue: + description: >- + The value of the attribute. Value type depends on the attribute + definition + oneOf: + - type: string + maxLength: 255 + minLength: 1 + example: lesson_3 + - $ref: '#/components/schemas/StringBooleanEnum' + - type: boolean + - description: 'Date in extended ISO 8601 datetime format: *2019-01-01T08:00:00+00*' + type: string + format: date-time + example: 2019-01-01T08:00:00+0000 + - type: integer + format: int64 + example: 1500 + NewCustomEvent: + type: object + allOf: + - $ref: '#/components/schemas/CustomEvent' + UpdateCustomEvent: + type: object + allOf: + - $ref: '#/components/schemas/CustomEvent' + CustomEvent: + required: + - name + - attributes + properties: + name: + description: Unique name of custom event + type: string + pattern: ^[a-z0-9_]{3,64}$ + example: sample_custom_event + attributes: + description: Optional collection of attributes + type: array + items: + $ref: '#/components/schemas/CustomEventAttributeDetails' + type: object + CustomEventDetails: + required: + - customEventId + - createdOn + properties: + customEventId: + description: The custom event ID + type: string + readOnly: true + example: hy7 + createdOn: + description: Date of creation custom event definition + type: string + format: date-time + readOnly: true + example: 2019-08-19T11:32:34+0000 + href: + description: Direct hyperlink to a resource + type: string + format: url + readOnly: true + example: https://api.getresponse.com/v3/custom-events/vBd5 + type: object + allOf: + - $ref: '#/components/schemas/CustomEvent' + CustomEventAttributeDetails: + required: + - customEventAttributeId + properties: + customEventAttributeId: + type: string + readOnly: true + example: gt7 + type: object + allOf: + - $ref: '#/components/schemas/CustomEventAttribute' + CustomEventAttribute: + required: + - name + - type + properties: + name: + description: Unique name of attribute + type: string + pattern: ^[a-z0-9_]{3,64}$ + example: sample_attribute + type: + description: Type of attribute + enum: + - string + - number + - datetime + - boolean + example: string + type: object + FormVariant: + properties: + variant: + description: The index of variants + type: string + readOnly: true + example: '0' + variantName: + type: string + example: Variant A + winner: + description: Is this variant the winner in the A/B test + $ref: '#/components/schemas/StringBooleanEnum' + status: + type: string + enum: + - published + - unpublished + - disabled + createdOn: + type: string + format: date-time + example: 2018-07-11T13:37:25+0000 + statistics: + $ref: '#/components/schemas/FormStatistics' + type: object + FormVariantDetails: + properties: + formId: + type: string + readOnly: true + example: pL4e + webformId: + description: Same as `formId` + type: string + readOnly: true + example: pL4e + variant: + description: The index of variants + type: string + readOnly: true + example: '0' + variantName: + type: string + example: Variant A + winner: + description: Is this variant the winner in the A/B test + type: string + enum: + - 'yes' + - 'no' + status: + type: string + enum: + - published + - unpublished + - disabled + createdOn: + type: string + format: date-time + example: 2018-07-09T15:45:12+0000 + numberOfVisitors: + description: The total number of form visitors + type: integer + format: int64 + example: 152 + numberOfUniqueVisitors: + description: The number of unique form visitors + type: integer + format: int64 + example: 136 + numberOfSubscribers: + description: The number of visitors who subscribed through this form + type: integer + format: int64 + example: 94 + subscriptionRate: + description: The ratio of `numberOfSubscribers` to `numberOfVisitors` + type: number + format: double + example: 0.62 + type: object + FormDetails: + type: object + allOf: + - $ref: '#/components/schemas/Form' + - properties: + settings: + $ref: '#/components/schemas/FormSettings' + variants: + type: array + items: + $ref: '#/components/schemas/FormVariant' + type: object + FormSettings: + properties: + optin: + description: >- + `single` - Single opt-in means that the contact will be added + without confirming their subscription first. `double` - Double + opt-in means that the contact will receive a subscription + confirmation email. + type: string + enum: + - single + - double + example: single + phase: + description: >- + The contact who subscribed via this form will be added to the + selected day in the autoresponder cycle. If null, the contact won't + be added to the cycle. + type: integer + format: int32 + maximum: 9999 + minimum: 0 + example: 5 + nullable: true + thankYouType: + description: What should happen when a new contact subscribes via the form. + type: string + enum: + - stay_on_page + - default + - custom_url + example: stay_on_page + thankYouUrl: + description: >- + The URL used to redirect the newly subscribed contacts when they + complete this form. Used if `thankYouType` is `custom_url`. + type: string + format: uri + example: https://example.com/thank-you + nullable: true + alreadySubscribedType: + description: What to do when the address already exists in the campaign + type: string + enum: + - stay_on_page + - default + - custom_url + example: stay_on_page + alreadySubscribedUrl: + description: >- + The URL used to redirect the already subscribed contacts when they + complete this form. Used if `alreadySubscribedType` is `custom_url`. + type: string + format: uri + example: https://example.com/thank-you + nullable: true + secondStageCaptcha: + description: Is captcha enabled for the form + $ref: '#/components/schemas/StringBooleanEnum' + forwardDataRequestType: + description: >- + How to forward form data to a thank-you page. [Learn + more](https://www.getresponse.com/help/building-contact-lists/forms-and-pop-ups/can-i-forward-subscriber-data-to-a-custom-thank-you-page.html). + `null` means that the data forwarding is turned off. + type: string + enum: + - GET + - POST + nullable: true + trackingCustomField: + description: >- + Subscribers added via this form will have this custom field set with + a value passed in `trackingCustomFieldValue` + type: string + nullable: true + $ref: '#/components/schemas/CustomFieldReference' + trackingCustomFieldValue: + description: See the `trackingCustomField` description + type: string + example: '123' + nullable: true + type: object + Form: + properties: + formId: + type: string + readOnly: true + example: pL4e + webformId: + description: Same as `formId` + type: string + readOnly: true + example: pL4e + name: + type: string + example: My first form + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/forms/pL4e + hasVariants: + description: Indicates if the form has variants (A/B tests) + type: boolean + readOnly: true + example: true + scriptUrl: + description: >- + The URL to a JavaScript file of the form. This is used to embed the + form within a web page. + type: string + format: uri + readOnly: true + example: >- + https://app.getresponse.com/view_webform_v2.js?u=nTfa&webforms_id=123 + status: + type: string + enum: + - published + - unpublished + - draft + example: published + createdOn: + type: string + format: date-time + example: 2018-07-02T11:22:33+0000 + statistics: + $ref: '#/components/schemas/FormStatistics' + campaign: + $ref: '#/components/schemas/CampaignReference' + type: object + FormStatistics: + properties: + visitors: + description: The total number of form visitors + type: integer + format: int64 + example: 4371 + uniqueVisitors: + description: The number of unique form visitors + type: integer + format: int64 + example: 3865 + subscribed: + description: The number of visitors that subscribed using this form + type: integer + format: int64 + example: 2594 + subscriptionRate: + description: The ratio of `subscribed` to `visitors` + type: number + format: double + example: 0.59 + type: object + BaseLandingPage: + properties: + landingPageId: + description: The landing page ID + type: string + example: avYn + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/landing-pages/avYn + metaTitle: + description: The landing page meta title property + type: string + example: Some meta title + domain: + description: The domain where the landing page is hosted + type: string + example: gr8.new + subdomain: + description: The subdomain where the landing page is assigned + type: string + example: summer-sale + userDomain: + description: The private domain provided by the user + type: string + example: '' + userDomainPath: + description: The private domain path provided by the user + type: string + example: '' + campaign: + description: The campaign to which the landing page is linked + allOf: + - $ref: '#/components/schemas/CampaignReference' + status: + description: The landing page status + allOf: + - $ref: '#/components/schemas/StatusEnum' + userDomainStatus: + description: >- + The DNS status for the user's private domain. Can be `null` if a + private domain isn't assigned. + type: string + enum: + - active + - inactive + - waiting + nullable: true + testAB: + description: Does the landing page have AB testing (variants) enabled + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + updatedOn: + description: The date of the last page update + type: string + format: date-time + readOnly: true + type: object + LandingPageVariant: + properties: + variantId: + description: The landing page variant ID. + type: string + example: PKxn + variant: + description: The variant index. + type: string + format: integer + example: '0' + winner: + type: boolean + example: true + visitors: + type: string + format: integer + example: '12' + uniqueVisitors: + type: string + format: integer + example: '2' + subscribed: + type: string + format: integer + example: '2' + type: object + LandingPage: + properties: + metaDescription: + description: The landing page meta description property + type: string + example: Some meta description + metaNoindex: + description: >- + To entirely prevent your page content from being listed in the + Google web index, even if other sites link to it use a noindex meta + tag + type: string + enum: + - 'yes' + - 'no' + dayOfCycle: + description: >- + Contacts subscribed via the landing page will be added to the + autoresponder cycle. `Null` if contacts shouldn't be added to the + cycle. + type: integer + format: int32 + maximum: 9999 + minimum: 0 + example: 2 + nullable: true + optin: + description: The opt-in type (double or single) + type: string + enum: + - single + - double + favicoUrl: + description: The favicon URL. Can be `null` if a favicon isn't present + type: string + format: uri + example: https://my-landing-page.mohahaha.com/favico.ico + nullable: true + thankYouPageType: + description: What should happen after a contact subscribes + type: string + enum: + - stay_on_page + - default + - custom_url + thankYouPageUrl: + description: >- + The `thank-you` page URL. Can be empty if a custom thank-you page + isn't being used + type: string + format: uri + example: https://my-landing-page.mohahaha.com/thank_you.html + url: + description: The landing page URL + type: string + format: uri + example: https://my-landing-page.mohahaha.com + variants: + type: array + items: + $ref: '#/components/schemas/LandingPageVariant' + type: object + allOf: + - $ref: '#/components/schemas/BaseLandingPage' + NewImport: + required: + - campaignId + - contacts + - fieldMapping + properties: + campaignId: + description: The ID of the destination campaign (list) + type: string + example: z5c + fieldMapping: + description: >- + Mapping definition for such contact properties as email address, + name, or custom fields. It's the equivalent of column headers in a + CSV file used to import contacts in a GetResponse account. The + `email` value is required. For custom fields, provide only custom + fields name in the mapping. Include their values in the + corresponding field in the contact array + type: array + items: + type: string + example: email + contacts: + description: >- + Container for a contact definition. Include the values defined in + the `fieldMapping` array + type: array + items: + $ref: '#/components/schemas/NewImportContact' + type: object + NewImportContact: + type: array + items: + type: string + example: example@somedomain.com + Import: + properties: + importId: + description: The import ID + type: string + readOnly: true + example: o6gE + campaign: + type: object + $ref: '#/components/schemas/CampaignReference' + status: + type: string + enum: + - uploaded + - review + - approved + - rejected + - finished + - canceled + - to_review + readOnly: true + statistics: + description: The import statistics + type: object + $ref: '#/components/schemas/ImportStatistics' + errorStatistics: + description: The detailed import error statistics + type: object + $ref: '#/components/schemas/ImportErrorStatistics' + createdOn: + type: string + format: date-time + finishedOn: + type: string + format: date-time + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/imports/o6gE + type: object + ImportStatistics: + required: + - uploaded + - invalid + - updated + - addedToList + properties: + uploaded: + description: The number of uploaded contacts + type: integer + format: int64 + readOnly: true + example: 25 + invalid: + description: The number of invalid contacts + type: integer + format: int64 + readOnly: true + example: 5 + updated: + description: The number of updated contacts + type: integer + format: int64 + readOnly: true + example: 10 + addedToList: + description: The number of added contacts + type: integer + format: int64 + readOnly: true + example: 10 + type: object + ImportErrorStatistics: + properties: + syntaxErrors: + description: The number of contacts with a syntax error + type: integer + format: int64 + readOnly: true + example: 2 + alreadyInQueue: + description: The number of contacts already in queue + type: integer + format: int64 + readOnly: true + example: 1 + invalidDomains: + description: The number of contacts with invalid domains + type: integer + format: int64 + readOnly: true + example: 1 + blacklist: + description: The number of blocked contacts + type: integer + format: int64 + readOnly: true + example: 1 + policyFailures: + description: The number of contacts rejected for policy reasons + type: integer + format: int64 + readOnly: true + example: 1 + mismatchedCriteria: + description: >- + The number of contacts rejected because of mismatched criteria, + [learn + more](https://www.getresponse.com/help/managing-contacts/working-with-contact-lists/where-can-i-find-import-statistics.html#what-do-the-numbers-for-uploaded-approved-and-import-errors-mean) + type: integer + format: int64 + readOnly: true + example: 1 + type: object + SmsStats: + required: + - smsId + properties: + smsId: + description: The SMS message ID + type: string + example: PvLI8C + totalSms: + description: The number of SMS messages sent + type: integer + example: 1 + totalRecipients: + description: The number of recipients + type: integer + example: 1 + totalClicks: + description: The number of link clicks from an SMS message + type: integer + example: 1 + totalUnsubscribes: + description: The number of opt-outs from an SMS message + type: integer + example: 1 + totalPrice: + description: Cost details of a specific SMS + type: object + nullable: false + allOf: + - properties: + amount: + description: Total SMS message cost + type: string + example: '0.0240' + currency: + description: Pricing currency + type: string + example: USD + type: object + link: + description: Link details + type: object + nullable: false + allOf: + - properties: + url: + description: Link URL + type: string + example: https://getresponse.com + clicks: + description: The number of link clicks from an SMS message + type: integer + example: 1 + type: object + countryStatistics: + description: SMS message statistics per country + type: object + nullable: false + allOf: + - properties: + countryCode: + description: Country code + type: string + example: PL + recipients: + description: The number of recipients + type: integer + example: 1 + smsCount: + description: The number of messages sent + type: integer + example: 1 + price: + description: Pricing details + type: object + allOf: + - properties: + price: + description: Total cost + type: string + example: '0.0240' + currency: + description: Pricing currency + type: string + example: USD + type: object + type: object + type: object + RevenueStatistics: + properties: + currency: + description: Statistics currency + type: string + example: USD + timeSeries: + type: array + items: + properties: + timeInterval: + description: >- + Orders and revenue are grouped by time intervals. Interval + length is set automatically and depends on the `orderDate` + parameter. + type: string + pattern: >- + /^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?(\/)P(?=\w*\d)(?:\d+Y|Y)?(?:\d+M|M)?(?:\d+W|W)?(?:\d+D|D)?(?:T(?:\d+H|H)?(?:\d+M|M)?(?:\d+(?:\­.\d{1,2})?S|S)?)?$/ + example: 2014-09-20T00:00:00+0000/P2M18DT10H0M0S + revenue: + description: Revenue + type: number + example: 2.45 + orders: + description: Number of orders + type: integer + example: 5 + type: object + type: object + GeneralPerformanceStats: + properties: + currency: + description: Statistics currency + type: string + example: USD + order: + description: Order statistics + type: object + nullable: false + allOf: + - properties: + orders: + description: Number of orders + type: integer + example: 5 + ordersTrend: + description: Order trend + type: number + example: 1.23 + avgOrderRevenue: + description: Average order value + type: number + example: 1.23 + avgOrderRevenueTrend: + description: Average order value trend + type: number + example: 1.23 + type: object + revenue: + description: Revenue statistics + type: object + nullable: false + allOf: + - properties: + revenue: + description: Revenue from orders + type: number + example: 1.23 + revenueTrend: + description: Revenue trend + type: number + example: 1.23 + type: object + type: object + PredefinedField: + properties: + predefinedFieldId: + type: string + readOnly: true + example: 6neM + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/predefined-fields/6neM + name: + type: string + maxLength: 32 + minLength: 1 + pattern: ^[A-Za-z0-9_]{1,32}$ + example: my_predefined_field_123 + value: + type: string + maxLength: 350 + minLength: 1 + example: my value + campaign: + type: object + $ref: '#/components/schemas/CampaignReference' + type: object + PredefinedFieldDetails: + description: The predefined field details. + type: object + readOnly: true + allOf: + - $ref: '#/components/schemas/PredefinedField' + Suppression: + required: + - suppressionId + properties: + suppressionId: + description: The suppression ID + type: string + readOnly: true + example: pypF + name: + description: The suppression name + type: string + example: suppression-name + createdOn: + description: Created on DateTime in the ISO8601 format + type: string + format: date-time + readOnly: true + example: 2018-07-26T06:33:13+0000 + href: + description: Direct hyperlink to a resource + type: string + readOnly: true + example: https://api.getresponse.com/v3/suppressions/pypF + type: object + BaseSuppression: + properties: + name: + description: The name of the suppression list + type: string + example: suppression-name + masks: + type: array + items: + type: string + example: '@example.com' + type: object + SuppressionDetails: + type: object + readOnly: true + allOf: + - $ref: '#/components/schemas/Suppression' + - $ref: '#/components/schemas/BaseSuppression' + SubscriptionConfirmationBody: + properties: + subscriptionConfirmationBodyId: + description: Subscription confirmation subject ID + type: string + example: asS1 + name: + description: Name + type: string + example: Database signup + contentPlain: + description: Plain text content equivalent of confirmation message + type: string + example: > + + Hello {{CONTACT \"subscriber_first_name\"}}, + \r\n \r\n{{INTERNAL \"body\"}}\r\n + + Your request to sign up to our\r\ndatabase has been received + and\r\nrequires your confirmation.\r\n\r\n + + EASY 1-CLICK CONFIRMATION:\r\n{{LINK \"confirm\"}}\r\n\r\nYou will + be added to the database\r\n + + instantly upon your confirmation.\r\n\r\n\r\nYou will be able to + unsubscribe\r\nor change your details at any time.\r\n\r\n + + If you have received this email in\r\nerror and did not intend to + join\r\nour database, no further action is\r\n + + required on your part.\r\n\r\nYou won't receive + further\r\ninformation and you won't be\r\n + + subscribed to any list until you\r\nconfirm your request + above.\r\n\r\n{{INTERNAL \"signature\"}} + contentHtml: + description: HTML content of confirmation message + type: string + example: '[HTML_CODE]' + type: object + SubscriptionConfirmationSubject: + properties: + subscriptionConfirmationSubjectId: + description: Subscription confirmation subject ID + type: string + example: AS3A + subject: + description: Subject + type: string + example: Action Requested - please confirm your subscription. + isPrivate: + description: Is private + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + type: object + ShopDetails: + properties: + shopId: + description: The shop ID + type: string + readOnly: true + example: pf3 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3 + name: + description: The shop name + type: string + maxLength: 124 + minLength: 4 + example: Monster market + locale: + description: The language locale (ISO 639-1) + type: string + example: PL + currency: + description: The currency code (ISO 4217) + type: string + example: PLN + productCount: + description: Amount of products in the shop + type: integer + example: '10' + productRevenue: + description: Total revenue from purchased products + type: number + example: '1.23' + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + PopupGeneralPerformanceStats: + required: + - popupId + properties: + popupId: + description: The form or popup ID + type: string + example: 7189c47e-e45f-4c45-a882-08649c48ff96 + views: + description: The total number of times your popup was viewed by website visitors + type: integer + format: int64 + example: 9 + clicks: + description: The number of clicks + type: integer + format: int64 + example: 2 + ctr: + description: >- + The number of clicks divided by the number of views, shown as a + percentage + type: integer + format: int64 + example: 5 + leads: + description: The number of leads + type: integer + format: int64 + example: 2 + type: object + PopupDetails: + properties: + popupId: + description: The form or popup ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/popups/ce84fabc-1349-4992-a2d7-0c44c5534128 + name: + description: The form or popup name + type: string + example: My popup name + status: + description: The form or popup status + type: string + enum: + - published + - unpublished + readOnly: true + type: + description: The form or popup type + type: string + enum: + - popup + - inline + readOnly: true + thumbnailUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://us-wbe-img2.gr-cdn.com/user/X/Y.webp + createdAt: + description: >- + The date the form or popup was created. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-01T10:35:00`. + type: string + format: date-time + example: '2024-01-01T10:35:00' + updatedAt: + description: >- + The date the form or popup was updated. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-10T10:00:00`. + type: string + format: date-time + example: '2024-01-10T10:00:00' + type: object + PopupListItem: + properties: + popupId: + description: The form or popup ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/popups/6b0d7d59-71d9-4708-80a6-aa0f13805111 + name: + description: The form or popup name + type: string + example: My popup name + status: + description: The form or popup status + type: string + enum: + - published + - unpublished + readOnly: true + type: + description: The form or popup type + type: string + enum: + - popup + - inline + readOnly: true + createdAt: + description: >- + The date the form or popup was created. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-01T10:35:00`. + type: string + format: date-time + updatedAt: + description: >- + The date the form or popup was updated. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-10T10:00:00`. + type: string + format: date-time + statistics: + description: The landing page statistics + $ref: '#/components/schemas/PopupListItemStatistics' + type: object + PopupListItemStatistics: + properties: + views: + description: The total number of times your popup was viewed by website visitors + type: integer + format: int64 + example: 9 + uniqueVisitors: + description: The total number of visitors + type: integer + format: int64 + example: 10 + leads: + description: The number of leads + type: integer + format: int64 + example: 5 + ctr: + description: >- + The number of clicks divided by the number of views, shown as a + percentage + type: integer + format: int64 + example: 52 + type: object + SplittestNewsletter: + properties: + newsletterId: + description: The newsletter ID + type: string + example: Z6e + href: + description: The direct newsletter URL + type: string + format: uri + example: https://api.getresponse.com/v3/newsletters/B2fvv + name: + description: The newsletter name + type: string + example: Newsletter name + subject: + description: The newsletter subject + type: string + example: Example subject + fromField: + description: The \"From\" address for the newsletter + type: object + $ref: '#/components/schemas/FromFieldReference' + status: + description: The status of the newsletter + type: string + enum: + - sampled + - chosen + - rejected + sendOn: + description: The date when the newsletter was sent + type: string + format: date-time + example: 2015-06-25T20:05:10+0000 + samplingTargets: + description: The newsletter sample targets + type: string + format: int32 + example: '2' + samplingDelivered: + description: The newsletter sample delivery + type: string + format: int32 + example: '2' + scoreOpens: + description: The newsletter open rate + type: string + format: int32 + example: '2' + scoreClicks: + description: The newsletter click rate + type: string + format: int32 + example: '2' + type: object + Splittest: + properties: + splittestId: + description: A/B test ID + type: string + example: A3r + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/splittests/A3r + name: + description: A/B test name + type: string + example: A/B test + campaign: + description: A/B test campaign + type: object + $ref: '#/components/schemas/CampaignReference' + status: + description: A/B test status + type: string + enum: + - active + - inactive + winningCriteria: + description: A/B test winning criteria + type: string + enum: + - open + - click + nullable: true + winningTarget: + description: A/B test wining target + type: string + format: int32 + example: '10' + stage: + description: A/B test stage + type: string + enum: + - queued + - schedule_sampling + - evaluate_sampling + - choose_winning + - schedule_winning + - send_winning + - canceled_queued + - canceled_sampling + - canceled_winning + - incomplete + - finished + type: + description: A/B test type + type: string + enum: + - content + - subject + - day + - hour + - from_field + samplingPercentage: + description: A/B test sample percentage + type: string + format: int32 + example: '18' + nullable: true + samplingTime: + description: A/B test sampling time in seconds + type: string + format: int32 + example: '86400' + nullable: true + chooseWinning: + description: The method of choosing the winning A/B test + type: string + enum: + - automatic + - manual + nullable: true + winningScoreOpens: + description: The open rate of the winning A/B test + type: string + format: int32 + example: '5' + winningScoreClicks: + description: The click rate of the winning A/B test + type: string + format: int32 + example: '3' + winningDelivered: + description: The delivery rate of the winning A/B test + type: string + format: int32 + example: '12' + winningScheduleOn: + description: The date for wchich the winning A/B test was scheduled + type: string + format: date-time + example: 2015-06-25T20:05:10+0000 + nullable: true + nextStepOn: + description: The date of the next step in the A/B test + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + evaluationSkippedOn: + description: The date when the A/B test was skipped + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + canceledOn: + description: The date when the A/B test was canceled + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + createdOn: + description: The date when the A/B test was created + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + newsletters: + description: The newsletters that are associated with the A/B test + type: array + items: + $ref: '#/components/schemas/SplittestNewsletter' + sendSettings: + description: The send settings for the A/B test + properties: + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSupressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + type: object + NewFile: + required: + - name + - extension + - content + - folder + properties: + content: + description: The base64 encoded file content + type: string + format: byte + example: dGVzdCBjb250ZW50 + type: object + allOf: + - $ref: '#/components/schemas/BaseFile' + BaseFile: + properties: + name: + description: The file name + type: string + maxLength: 255 + minLength: 1 + example: image + extension: + description: The file extension + type: string + example: jpg + folder: + description: The folder where the file is stored + nullable: true + allOf: + - $ref: '#/components/schemas/FolderShort' + type: object + FileGroup: + description: The file group + type: string + enum: + - audio + - video + - photo + - document + example: photo + FolderShort: + required: + - folderId + properties: + folderId: + description: The folder ID + type: string + example: 4a9f + type: object + File: + required: + - fileId + properties: + fileId: + description: The file ID + type: string + readOnly: true + example: 6rZ6 + fileSize: + description: The file size + type: integer + format: int64 + readOnly: true + example: 579644 + group: + readOnly: true + $ref: '#/components/schemas/FileGroup' + thumbnail: + description: The direct URL to the file thumbnail + type: string + format: uri + readOnly: true + example: >- + https://us-rs.gr-cdn.com/512x,sBIbGHAUIQfw7kTUjaD0fTzxfXPggsY_1WCWIKl3RAxE=/https://multimedia.getresponse.com/getresponse-ZJtEw/photos/05c53ab1-6119-4076-a96c-bbefa082ea1a.jpg + nullable: true + url: + description: The direct URL to resource + type: string + format: uri + readOnly: true + example: >- + https://multimedia.getresponse.com/getresponse-ZJtEw/photos/05c53ab1-6119-4076-a96c-bbefa082ea1a.jpg + properties: + description: The file properties (available only for the `photos` group) + type: array + items: + $ref: '#/components/schemas/FileProperty' + maxItems: 2 + minItems: 0 + readOnly: true + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + example: 2019-10-12T15:15:49+0000 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/file-library/files/6pS + type: object + allOf: + - $ref: '#/components/schemas/BaseFile' + FileProperty: + required: + - name + - value + properties: + name: + type: string + enum: + - width + - height + readOnly: true + example: width + value: + readOnly: true + oneOf: + - type: integer + example: 1980 + - type: string + type: object + Quota: + properties: + limit: + description: The total size of available storage space + type: integer + format: int64 + example: 1048576 + usage: + description: The currently used storage space + type: integer + format: int64 + example: 1024 + type: object + Folder: + required: + - folderId + properties: + folderId: + description: The folder ID + type: string + readOnly: true + example: t1G + name: + description: The folder name + type: string + maxLength: 128 + minLength: 1 + example: sample folder + size: + description: The size of all files in the directory + type: integer + format: int64 + example: 9564899 + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + example: 2019-10-14T17:17:13+0000 + type: object + NewFolder: + required: + - name + properties: + name: + description: The folder name + type: string + maxLength: 128 + minLength: 1 + example: sample folder + type: object + AbtestsSubjectDetails: + type: object + allOf: + - $ref: '#/components/schemas/AbtestsSubjectListItem' + - properties: + winnerSendingStart: + description: Date the winning message was sent on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + statistics: + description: The statistics of A/B test + properties: + total: + type: object + $ref: '#/components/schemas/AbtestsSubjectStatistics' + winner: + type: object + $ref: '#/components/schemas/AbtestsSubjectStatistics' + type: object + readOnly: true + variants: + type: array + items: + properties: + variantId: + description: >- + The message variant ID. A variant identifier from + https://apireference.getresponse.com/#operation/getAbtestsSubjectById. + type: string + readOnly: true + example: VpKJdr + subject: + description: Variant's subject + type: string + maximum: 150 + minimum: 1 + example: variant + isWinner: + description: Winning variant + type: boolean + readOnly: true + example: true + statistics: + description: Variant's statistics + type: object + readOnly: true + allOf: + - $ref: '#/components/schemas/AbtestsSubjectStatistics' + type: object + sendSettings: + description: The send settings for the A/B test + properties: + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSupressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + editor: + description: The message editor used for the A/B test + type: string + enum: + - html2 + - custom + - text + - editor_v3 + - getresponse + - legacy + nullable: true + content: + $ref: '#/components/schemas/MessageContent' + type: object + AbtestsSubjectStatistics: + properties: + delivered: + description: >- + The total number of delivered messages (winner and variants + combined) + type: integer + example: 10 + openRate: + description: The sum total of opens for the variants and the winner + type: integer + example: 8 + clickRate: + description: The message click rate + type: integer + example: 8 + type: object + AbtestsSubjectListItem: + type: object + allOf: + - $ref: '#/components/schemas/AbtestsSubject' + - properties: + status: + description: Newsletter status + type: string + enum: + - active + - inactive + - deleted + readOnly: true + stage: + description: A/B test stage + type: string + enum: + - preparing + - testing + - finished + - sending_winner + - cancelled + - draft + - completed + readOnly: true + deliverySettings: + description: The A/B test delivery settings + properties: + sendOn: + description: Date the newsletter was sent on + properties: + date: + description: Date the newsletter was sent on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + timeZone: + description: Time zone in which the newsletter was sent + properties: + timeZoneId: + description: ID of the time zone the newsletter was sent in + type: integer + timeZoneName: + description: Name of the time zone the newsletter was sent in + type: integer + nullable: true + timeZoneOffset: + description: >- + Time zone, or UTC, offset for when the newsletter + was sent + type: integer + nullable: true + type: object + type: object + winnerMode: + description: A/B test winner selection mode + type: string + enum: + - automatic + - manual + winningCriteria: + description: A/B test winning criteria + type: string + enum: + - open + - click + samplingPercentage: + description: Size of the test (sampling) group, expressed as a percentage + type: integer + format: int32 + maximum: 50 + minimum: 1 + samplingTime: + description: >- + A/B testing phase duration. The time after which the + remaining recipients will be sent the winning message + type: string + format: ISO-8601 duration + example: '86400' + nullable: true + type: object + flags: + type: array + items: + description: Tracking options enabled for the newsletter + type: string + enum: + - clicktrack + - subscription_reminder + - openrate + - google_analytics + - manual_list + - custom_footer + - ecommerce_tracking + readOnly: true + createdOn: + description: Date the A/B test was created on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + updatedOn: + description: Date A/B test was updated on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/ab-tests/subject/A3r + type: object + AbtestsSubject: + properties: + abTestId: + description: A/B test ID + type: string + readOnly: true + example: A3r + name: + description: A/B test name + type: string + maxLength: 100 + minLength: 1 + example: A/B test + campaign: + description: List linked to A/B test + properties: + campaignId: + description: Campaign ID + type: string + example: C + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/campaigns/C + name: + description: The campaign name + type: string + readOnly: true + example: Promo campaign + nullable: true + type: object + fromField: + description: Newsletter's From" address" + properties: + fromFieldId: + description: The 'From' address ID + type: string + example: V + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/V + type: object + replyTo: + description: Newsletter's reply-to address + properties: + fromFieldId: + description: The 'From' address ID + type: string + example: V + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/V + type: object + type: object + NewAbtestsSubject: + required: + - name + - href + type: object + allOf: + - required: + - name + - campaign + - fromField + properties: + abTestId: + description: A/B test ID + type: string + readOnly: true + example: A3r + name: + description: A/B test name + type: string + maxLength: 100 + minLength: 1 + example: A/B test + campaign: + description: List linked to A/B test + type: object + $ref: '#/components/schemas/CampaignReference' + fromField: + description: Newsletter's From" address" + type: object + $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: Newsletter's reply-to address + type: object + $ref: '#/components/schemas/FromFieldReference' + type: object + - required: + - deliverySettings + - variants + - sendSettings + - content + properties: + deliverySettings: + description: The A/B test delivery settings + required: + - samplingTime + - winningCriteria + - winnerMode + - sendOn + properties: + sendOn: + description: Date the newsletter was sent on + required: + - sendingType + properties: + sendingType: + description: >- + Newsletter send type. Please note that date and timezone + are not allowed with the 'now' option + type: string + enum: + - now + - scheduled + example: scheduled + date: + description: Date the newsletter was sent on + type: string + format: Y-m-d H:i:s + example: '2015-07-25T20:05:10' + nullable: true + timeZone: + description: Time zone in which the newsletter was sent + required: + - date + - timeZoneId + properties: + timeZoneId: + description: ID of the time zone the newsletter was sent in + type: integer + example: 285 + type: object + type: object + winnerMode: + description: A/B test winner selection mode + type: string + enum: + - automatic + - manual + winningCriteria: + description: A/B test winning criteria + type: string + enum: + - open + - click + samplingPercentage: + description: Size of the test (sampling) group, expressed as a percentage + type: integer + format: int32 + maximum: 50 + minimum: 1 + samplingTime: + description: >- + A/B testing phase duration. The time after which the + remaining recipients will be sent the winning message + type: string + format: ISO-8601 duration + example: P0Y0M0DT5H30M0S + nullable: true + type: object + flags: + type: array + items: + description: Tracking options enabled for the newsletter + type: string + enum: + - clicktrack + - google_analytics + - ecommerce_tracking + variants: + description: >- + Message variants. Please note, the number of subject variants + should be between 2 and 5 + required: + - subject + type: array + items: + properties: + subject: + description: Variant's subject + type: string + maximum: 150 + minimum: 1 + example: variant + type: object + sendSettings: + description: The send settings for the A/B test + properties: + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSupressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + content: + $ref: '#/components/schemas/MessageContent' + type: object + ChooseWinnerAbtestsSubject: + required: + - variantId + properties: + variantId: + description: >- + The message variant ID. A variant identifier from + https://apireference.getresponse.com/#operation/getAbtestsSubjectById. + type: string + example: VpKJdr + type: object + ClickTrackResource: + properties: + clickTrackId: + type: string + example: C12t + name: + description: The name (label) of a click track + type: string + example: Click here + url: + description: The link URL of a click track + type: string + format: uri + example: https://example.com/shop + clicks: + description: The number of clicks counted for a click track + type: integer + format: int64 + example: 25951 + message: + type: object + $ref: '#/components/schemas/ClickTrackMessage' + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/click-tracks/C12t + type: object + ClickTrackMessage: + description: The source message reference for a click track + properties: + resourceId: + description: The ID identifying message resource + type: string + example: r35N + type: + description: The message type + type: string + enum: + - broadcast + - automation + - autoresponder + - rss + - splittest + - sms + example: broadcast + createdOn: + description: The message creation date + type: string + format: date-time + example: 2019-12-01T08:21:28+0000 + resourceType: + description: Type of the resource that represents the message in the API + type: string + enum: + - newsletters + - autoresponders + - rss-newsletters + - splittests + - sms + example: newsletters + href: + description: Direct URL to the resource that represents the message + type: string + format: uri + example: https://api.getresponse.com/v3/newsletters/r35N + type: object + MessageStatisticsListElement: + properties: + timeInterval: + description: >- + The statistics time frame in the ISO 8601 datetime format with + duration interval + type: string + pattern: >- + /^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?(\/)P(?=\w*\d)(?:\d+Y|Y)?(?:\d+M|M)?(?:\d+W|W)?(?:\d+D|D)?(?:T(?:\d+H|H)?(?:\d+M|M)?(?:\d+(?:\­.\d{1,2})?S|S)?)?$/ + example: 2014-09-20T00:00:00+0000/P2M18DT10H0M0S + sent: + type: integer + format: int32 + totalOpened: + type: integer + format: int32 + uniqueOpened: + type: integer + format: int32 + totalClicked: + type: integer + format: int32 + uniqueClicked: + type: integer + format: int32 + goals: + type: integer + format: int32 + uniqueGoals: + type: integer + format: int32 + forwarded: + type: integer + format: int32 + unsubscribed: + type: integer + format: int32 + bounced: + type: integer + format: int32 + complaints: + type: integer + format: int32 + type: object + SendNewsletterDraft: + required: + - messageId + - sendSettings + properties: + messageId: + description: The message identifier (equals to newsletterId) + type: string + example: 'N' + sendOn: + description: >- + The scheduled send date for the message in the ISO 8601 format. + **Please note:** To send your message immediately, omit the `sendOn` + section + type: string + format: date-time + sendSettings: + description: How the message will be delivered to the subscriber + allOf: + - $ref: '#/components/schemas/NewsletterSendSettingsDetails' + type: object + NewsletterAttachment: + properties: + fileName: + description: The file name + type: string + example: some_file.jpg + content: + description: The base64 encoded file content + type: string + format: byte + example: sdfadsfetsdjfdskafdsaf== + mimeType: + description: The file mime type + type: string + example: image/jpeg + type: object + ExternalLexpad: + description: >- + External Lexpad settings for the message, read more: [External + Lexpad](https://apidocs.getresponse.com/v3/dynamic-content/external-lexpad) + required: + - dataSourceUrl + properties: + dataSourceUrl: + description: URL to the endpoint that will provide data for External Lexpad + type: string + format: uri + maxLength: 2048 + minLength: 1 + example: https://example.com/external_lexpad + dataSourceToken: + description: >- + Token that will be sent in `X-Auth-Token` header to authenticate the + requests made to the endpoint + type: string + maxLength: 255 + minLength: 0 + example: cf4dfca78434bf927a7655c0c4d95a2a45c33b71 + nullable: true + type: object + NewsletterSendSettingsDetails: + properties: + selectedCampaigns: + description: The list of selected campaigns + items: + type: string + example: V + selectedSegments: + description: The list of selected segments + items: + type: string + example: S + selectedSuppressions: + description: The list of selected suppressions (suppressions exclude contacts) + items: + type: string + example: Se + excludedCampaigns: + description: The list of excluded campaigns + items: + type: string + example: O + excludedSegments: + description: The list of excluded segments + items: + type: string + example: R + selectedContacts: + description: The list of selected contacts + items: + type: string + example: Qs + timeTravel: + description: >- + Use the time travel functionality. This means that the system will + match the scheduled sending hour for the message to the time zone of + each recipient. As a result, sending may take up to 24 hours. + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + perfectTiming: + description: Use the perfect timing functionality + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + externalLexpad: + description: >- + External Lexpad settings for the message, read more: [External + Lexpad](https://apidocs.getresponse.com/v3/dynamic-content/external-lexpad) + nullable: true + allOf: + - $ref: '#/components/schemas/ExternalLexpad' + type: object + Newsletter: + required: + - newsletterId + - href + properties: + newsletterId: + description: The newsletter ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/newsletters/N + name: + description: The newsletter name + type: string + maxLength: 128 + minLength: 2 + example: New message + type: + description: The newsletter type + type: string + default: broadcast + enum: + - broadcast + - draft + status: + description: The newsletter status + readOnly: true + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + editor: + description: This describes how the content of the message was created + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + subject: + description: The message subject + type: string + maxLength: 128 + minLength: 2 + example: Annual report + fromField: + description: The 'From' email address used for the message + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The email that will be used as the reply-to address + allOf: + - $ref: '#/components/schemas/FromFieldReference' + campaign: + description: The newsletter must be assigned to a campaign + allOf: + - $ref: '#/components/schemas/CampaignReference' + sendOn: + description: >- + The scheduled send date and time for the newsletter in the ISO 8601 + format. + type: string + format: date-time + readOnly: true + attachments: + description: >- + The newsletter attachments. The size of all attachments combined + can't exceed 400KB + type: array + items: + $ref: '#/components/schemas/NewsletterAttachment' + sendSettings: + description: >- + How the message will be delivered to the subscriber. You can specify + multiple parameters. Then the system uses AND logic. + allOf: + - $ref: '#/components/schemas/NewsletterSendSettingsDetails' + sendMetrics: + description: The sending metrics + type: object + readOnly: true + allOf: + - properties: + status: + type: string + default: finished + enum: + - scheduled + - in_progress + - finished + sent: + description: Messages already sent + type: string + default: '0' + total: + description: The total amount of messages to send + type: string + default: '0' + type: object + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + NewNewsletter: + required: + - subject + - fromField + - campaign + - content + - sendSettings + properties: + content: + $ref: '#/components/schemas/MessageContent' + flags: + $ref: '#/components/schemas/MessageFlagsArray' + name: + description: The newsletter name + type: string + maxLength: 128 + minLength: 2 + example: New message + type: + description: The newsletter type + type: string + default: broadcast + enum: + - broadcast + - draft + editor: + description: This describes how the content of the message was created + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + subject: + description: The message subject + type: string + maxLength: 128 + minLength: 2 + example: Annual report + fromField: + description: The 'From' email address used for the message + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The email that will be used as the reply-to address + allOf: + - $ref: '#/components/schemas/FromFieldReference' + campaign: + description: The newsletter must be assigned to a campaign + allOf: + - $ref: '#/components/schemas/CampaignReference' + sendOn: + description: >- + The scheduled send date and time for the newsletter in the ISO 8601 + format. **Please note:** To send your message immediately, omit the + `sendOn` section + type: string + format: date-time + attachments: + description: >- + The newsletter attachments. The size of all attachments combined + can't exceed 400KB + type: array + items: + $ref: '#/components/schemas/NewsletterAttachment' + sendSettings: + description: >- + How the message will be delivered to the subscriber. You can specify + multiple parameters. Then the system uses AND logic. + allOf: + - $ref: '#/components/schemas/NewsletterSendSettingsDetails' + type: object + NewsletterDetails: + properties: + content: + $ref: '#/components/schemas/MessageContent' + clickTracks: + description: The list of tracked links + type: array + items: + $ref: '#/components/schemas/ClickTrack' + flags: + $ref: '#/components/schemas/MessageFlagsArray' + type: object + allOf: + - $ref: '#/components/schemas/Newsletter' + NewsletterListElement: + required: + - newsletterId + - href + properties: + newsletterId: + description: The newsletter ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/newsletters/N + name: + description: The newsletter name + type: string + maxLength: 128 + minLength: 2 + example: New message + type: + description: The newsletter type + type: string + default: broadcast + enum: + - broadcast + - draft + status: + description: The newsletter status + readOnly: true + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + editor: + description: This describes how the content of the message was created + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + subject: + description: The message subject + type: string + maxLength: 128 + minLength: 2 + example: Annual report + campaign: + description: The newsletter must be assigned to a campaign + allOf: + - $ref: '#/components/schemas/CampaignReference' + sendOn: + description: >- + The scheduled send date and time for the newsletter in the ISO 8601 + format. + type: string + format: date-time + sendSettings: + description: >- + How the message will be delivered to the subscriber. You can specify + multiple parameters. Then the system uses AND logic. + allOf: + - $ref: '#/components/schemas/NewsletterSendSettingsListing' + sendMetrics: + description: The sending metrics + type: object + readOnly: true + allOf: + - properties: + status: + type: string + default: finished + enum: + - scheduled + - in_progress + - finished + sent: + description: Messages already sent + type: string + default: '0' + total: + description: The total amount of messages to send + type: string + default: '0' + type: object + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + flags: + $ref: '#/components/schemas/MessageFlagsString' + type: object + NewsletterSendSettingsListing: + properties: + timeTravel: + description: >- + Use the time travel functionality. This means that the system will + match the scheduled sending hour for the message to the time zone of + each recipient. As a result, sending may take up to 24 hours. + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + perfectTiming: + description: Use the perfect timing functionality + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + type: object + ClickTrack: + properties: + clickTrackId: + type: string + example: C + url: + description: The tracked link + type: string + format: uri + example: https://example.com + name: + description: The tracked link name + type: string + example: press here + amount: + description: The number of clicks on a link in a message + type: string + example: '15' + type: object + NewsletterActivity: + properties: + activity: + description: The type of activity + type: string + enum: + - send + - open + - click + createdOn: + description: The date when activity occurred + type: string + format: date-time + example: 2019-10-21T11:08:45+0000 + contact: + description: The contact ID + allOf: + - $ref: '#/components/schemas/NewsletterActivityContactReference' + type: object + NewsletterActivityContactReference: + properties: + contactId: + description: The contact ID + type: string + example: pV3r + email: + description: The contact email + type: string + example: contact@domain.com + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/contacts/pV3r + type: object + NewTag: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseTag' + UpdateTag: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseTag' + TagDetails: + properties: + tagId: + description: The tag ID. + type: string + readOnly: true + createdAt: + type: string + format: date-time + readOnly: true + example: 2018-07-20T06:24:14+0000 + type: object + allOf: + - $ref: '#/components/schemas/BaseTag' + Tag: + required: + - tagId + - name + - href + - color + - createdAt + properties: + tagId: + description: The tag ID + type: string + readOnly: true + example: vBd5 + href: + description: The direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/tags/vBd5 + createdAt: + type: string + format: date-time + readOnly: true + example: 2020-11-20T08:00:00+0000 + type: object + allOf: + - $ref: '#/components/schemas/BaseTag' + BaseTag: + properties: + name: + description: The tag name + type: string + maxLength: 255 + minLength: 2 + pattern: ^[_a-zA-Z0-9]{2,255}$ + example: My_Tag + color: + description: The tag color (deprecated) + type: string + readOnly: true + deprecated: true + type: object + Blocklist: + properties: + masks: + type: array + items: + type: string + example: jack@somedomain.com + type: object + UpdateBlocklist: + required: + - masks + type: object + allOf: + - $ref: '#/components/schemas/Blocklist' + CustomFieldReference: + required: + - customField + properties: + customFieldId: + type: string + readOnly: true + example: pas + name: + description: >- + + The name of the custom field. It must meet the following + requirements: + * be unique + * use only lowercase letters, underscores and digits: [a-z0-9_]{1,128} + * not be equal to one of the merge words used in messages, i.e. `name`, `email`, `twitter`, `facebook`, `buzz`, `myspace`, `linkedin`, `digg`, `googleplus`, `pinterest`, `responder`, `campaign`, `change`. + type: string + maxLength: 128 + minLength: 1 + example: color + values: + description: >- + The list of assigned default values, starting from zero depending on + the custom field type. (Please see description). + type: array + items: + type: string + example: red + type: object + Lps: + type: object + allOf: + - $ref: '#/components/schemas/LpsListItem' + - properties: + statistics: + description: The landing page statistics + $ref: '#/components/schemas/LpsListItemStatistics' + type: object + LpsListItem: + properties: + lpsId: + description: The landing page ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/lps/6b0d7d59-71d9-4708-80a6-aa0f13805111 + name: + description: The landing page name + type: string + example: 'Predesigned #017' + status: + description: The landing page status + type: string + enum: + - published + - unpublished + readOnly: true + domainUrl: + description: The landing page domain + type: string + format: uri + readOnly: true + example: predesigned-017-52612.grweb.site + thumbnailUrl: + description: The URL of a landing page thumbnail + type: string + format: uri + readOnly: true + example: >- + https://us-wbe-img2.gr-cdn.com/user/e5c2094a-2354-459f-9b9f-6d0369ccae2c/6b0d7d59-71d9-4708-80a6-aa0f13805111.png?width=208 + isChatsEnabled: + description: Chats is enabled on the landing page + example: true + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + createdAt: + description: The date the landing page was created + type: string + format: date-time + updatedAt: + description: The date the landing page was updated + type: string + format: date-time + type: object + LpsListItemStatistics: + properties: + visits: + description: The number of browsing sessions initiated on your landing page + type: integer + format: int64 + example: 9 + leads: + description: Number of leads + type: integer + format: int64 + example: 5 + subscriptionRate: + description: >- + The number of leads divided by the number of visitors, shown as a + percentage + type: integer + format: int64 + example: 52 + type: object + LpsDetails: + type: object + allOf: + - $ref: '#/components/schemas/LpsListItem' + - $ref: '#/components/schemas/LpsDetailsStatistics' + - properties: + pages: + type: array + items: + $ref: '#/components/schemas/LpsPage' + type: object + LpsDetailsStatistics: + properties: + pageViews: + description: The total number of times your landing page was viewed or refreshed + type: integer + format: int64 + example: 9 + visits: + description: The number of browsing sessions initiated on your landing page + type: integer + format: int64 + example: 5 + uniqueVisitors: + description: The number of people who visited your landing page + type: integer + format: int64 + example: 5 + type: object + LpsPage: + properties: + uuid: + description: >- + The ID of a page associated with the landing page (i.e., 404 page + and thank you page) + type: string + readOnly: true + example: 6ee7597f-9bde-4b92-9411-2fb228c9fa34 + name: + description: >- + The name of a page associated with the landing page (i.e., 404 page + and thank you page) + type: string + example: Home + status: + description: >- + The status of a page associated with the landing page (i.e., 404 + page or thank you page) + type: string + enum: + - active + - inactive + url: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: /terms-of-service + redirectUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: '' + createdAt: + description: >- + The date a page associated with the landing page (i.e., 404 page or + thank you page) was created + type: string + format: date-time + type: object + LpsStats: + required: + - lpsId + properties: + lpsId: + description: The landing page ID + type: string + example: 6ee7597f-9bde-4b92-9411-2fb228c9fa34 + name: + type: string + example: Some example landing page + pageViews: + description: The total number of times your landing page was viewed or refreshed + type: integer + format: int64 + example: 9 + visits: + description: The number of browsing sessions initiated on your landing page + type: integer + format: int64 + example: 5 + uniqueVisitors: + description: The number of people who visited your landing page + type: integer + format: int64 + example: 5 + thumbnailUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://us-wbe-img2.gr-cdn.com/user/X/Y.webp + type: object + ImageDetails: + properties: + imageId: + description: Image ID + type: string + example: '123456' + originalImageUrl: + description: URL from which image was downloaded + type: string + format: uri + example: http://somesite.example.com/my_image.jpg + nullable: true + size: + description: Size in bytes + type: string + example: '1234567' + name: + description: Original name + type: string + example: original_image + thumbnailUrl: + description: Thumbnail URL + type: string + format: uri + example: >- + https://us-re.gr-cdn.com/114x/https://multimedia.getresponse.com/getresponse-hUXzv/photos/123456.jpg + url: + description: Asset URL + type: string + format: uri + example: >- + https://multimedia.getresponse.com/getresponse-hUXzv/photos/123456.jpg + extension: + description: File extension + type: string + enum: + - jpg + - gif + - png + - jpeg + - bmp + example: jpg + type: object + CreateMultimedia: + properties: + file: + type: string + format: binary + type: object + Tracking: + properties: + grid: + type: string + readOnly: true + example: 2fEBK5kj4ReCxUvd + snippet: + type: string + readOnly: true + example: >- + + snippetV2: + type: string + readOnly: true + example: + type: object + FacebookPixel: + properties: + name: + type: string + readOnly: true + example: integration-pixel + pixelId: + type: string + readOnly: true + example: '123' + type: object + StatusEnum: + type: string + enum: + - enabled + - disabled + StringBooleanEnum: + type: string + enum: + - 'true' + - 'false' + SortOrderEnum: + type: string + enum: + - ASC + - DESC + DateOrDateTime: + oneOf: + - type: string + format: date + example: '2018-04-15' + - type: string + format: date-time + example: 2018-01-15T13:30:42+0000 + ErrorResponse: + required: + - httpStatus + - code + - codeDescription + - message + - moreInfo + - context + - uuid + properties: + httpStatus: + description: HTTP response code + type: integer + format: int32 + code: + description: API error code + type: integer + format: int32 + codeDescription: + description: API error code description + type: string + message: + description: Error message + type: string + moreInfo: + description: URL to error description in the API Docs + type: string + context: + type: array + items: + type: string + uuid: + description: UUID of the error response + type: string + type: object + AccountBadgeDetails: + properties: + status: + description: Current badge status + example: enabled + $ref: '#/components/schemas/StatusEnum' + type: object + UpdateAccountBadge: + required: + - status + type: object + allOf: + - $ref: '#/components/schemas/AccountBadgeDetails' + SendingLimitsListItem: + properties: + timeFrame: + description: Time frame, measured in seconds + type: integer + example: 2592000 + limit: + description: The number of email sends available within a given time frame + type: integer + example: 2500 + used: + description: The number of email sends used within the given time frame + type: integer + example: 0 + type: object + IndustryTagId: + properties: + industryTagId: + description: Industry tag ID + type: string + format: integer + example: '1' + type: object + IndustryTagProperties: + properties: + name: + type: string + readOnly: true + example: Marketing agencies + description: + type: string + readOnly: true + example: Marketing agencies big and small, with fluent and wise agents... + type: object + IndustryTag: + required: + - industryTagId + type: object + allOf: + - $ref: '#/components/schemas/IndustryTagId' + - $ref: '#/components/schemas/IndustryTagProperties' + TimezoneName: + properties: + name: + description: >- + Time zone name as defined by + https://en.wikipedia.org/wiki/List_of_tz_database_time_zones + type: string + example: Europe/Warsaw + type: object + TimezoneOffset: + properties: + offset: + type: string + pattern: /^(?:Z|[+-](?:2[0-3]|[01][0-9]):[0-5][0-9])$/ + example: '+01:00' + type: object + TimezoneId: + properties: + timezoneId: + type: integer + format: int32 + example: 1 + type: object + TimezoneCountry: + properties: + country: + type: string + example: Poland + type: object + Timezone: + required: + - timezoneId + allOf: + - $ref: '#/components/schemas/TimezoneId' + - $ref: '#/components/schemas/TimezoneName' + - $ref: '#/components/schemas/TimezoneOffset' + - $ref: '#/components/schemas/TimezoneCountry' + AccountsLoginHistoryListElement: + properties: + loginTime: + description: Login time + type: string + format: date-time + example: 2004-02-12T15:19:21+0000 + logoutTime: + description: Logout time + type: string + format: date-time + example: 2004-02-12T15:19:21+0000 + nullable: true + isSuccessful: + description: Login was successful + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + ip: + description: IP address + type: string + format: ipv4 + example: 192.0.0.1 + type: object + CallbackActions: + properties: + open: + description: Is `open` callback enabled + type: boolean + click: + description: Is `click` callback enabled + type: boolean + goal: + description: Is `goal` callback enabled + type: boolean + subscribe: + description: Is `subscribe` callback enabled + type: boolean + unsubscribe: + description: Is `unsubscribe` callback enabled + type: boolean + survey: + description: Is `survey` callback enabled + type: boolean + type: object + Callback: + properties: + url: + description: URL to use to post notifications + format: uri + actions: + $ref: '#/components/schemas/CallbackActions' + type: object + AccountDetailsCountryCode: + properties: + countryCodeId: + description: Country code ID + type: string + example: '175' + countryCode: + description: Country code + type: string + example: PL + type: object + AccountBilling: + properties: + listSize: + description: Billing plan maximum list size + type: string + example: '2500' + paymentPlan: + description: Payment plan + type: string + enum: + - Free Trial + - Monthly + - 12 Months + - 24 Months + example: Monthly + subscriptionPrice: + description: Subscription price + type: integer + example: 25 + renewalDate: + description: Subscription reneval date + type: string + format: date + example: '2017-01-01' + currencyCode: + description: Currency code compliant with ISO-4217 + type: string + example: USD + accountBalance: + description: Account balance + type: string + example: '-15.00' + price: + description: Price + type: integer + example: 25 + paymentMethod: + description: Payment method + type: string + enum: + - outside_system + - inside_system + - credit_card + - platnosci_pl + - direct_debit + - paypal + - yandex + - alipay + - alipay_mobile + - boleto + - ideal + - qiwi + - sofort + - webmoney + example: credit_card + creditCard: + type: object + nullable: true + allOf: + - properties: + number: + description: Masked credit card number + type: string + example: XXXXXXXXX0123 + type: object + - properties: + expirationDate: + description: Expiration date + type: string + format: date + example: '2014-01-01' + type: object + addons: + description: Addons + type: array + items: + properties: + name: + description: Addon name + type: string + example: Landing Page Creator + price: + description: Addon price + type: integer + example: 15 + active: + description: Addon active status + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + type: object + type: object + SubscriptionsByDatesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignSubscriptionStatisticsList' + CampaignSubscriptionStatisticsList: + description: Dates in the YYYY-MM-DD format are used as keys. + type: object + example: + '2014-12-15': + V: + import: 10 + email: 11 + www: 10 + panel: 14 + leads: 3 + sale: 3 + api: 1 + forward: 15 + survey: 6 + mobile: 12 + copy: 7 + landing_page: 4 + summary: 99 + p: + import: 9 + email: 7 + www: 9 + panel: 5 + leads: 3 + sale: 3 + api: 8 + forward: 10 + survey: 8 + mobile: 10 + copy: 10 + landing_page: 7 + summary: 93 + additionalProperties: + description: Dates in YYYY-MM-DD format are used as keys + type: object + allOf: + - $ref: '#/components/schemas/CampaignSubscriptionStatisticsItemByCampaign' + CampaignRemovalsStatisticsItem: + type: object + anyOf: + - properties: + api: + type: integer + example: 1 + type: object + - properties: + automation: + type: integer + example: 1 + type: object + - properties: + blacklisted: + type: integer + example: 1 + type: object + - properties: + bounce: + type: integer + example: 1 + type: object + - properties: + cleaner: + type: integer + example: 1 + type: object + - properties: + compliant: + type: integer + example: 1 + type: object + - properties: + support: + type: integer + example: 1 + type: object + - properties: + unsubscribe: + type: integer + example: 1 + type: object + - properties: + user: + type: integer + example: 1 + type: object + CampaignSubscriptionStatisticsItemByCampaign: + description: The properties of the result are indexed with the campaign ID. + type: object + example: + V: + import: 10 + email: 11 + www: 10 + panel: 14 + leads: 3 + sale: 3 + api: 1 + forward: 15 + survey: 6 + mobile: 12 + copy: 7 + landing_page: 4 + webinar: 3 + summary: 99 + p: + import: 9 + email: 7 + www: 9 + panel: 5 + leads: 3 + sale: 3 + api: 8 + forward: 10 + survey: 8 + mobile: 10 + copy: 10 + landing_page: 7 + webinar: 4 + summary: 93 + additionalProperties: + description: The properties of the result are indexed with the campaign ID + $ref: '#/components/schemas/CampaignSubscriptionStatisticsItem' + CampaignSubscriptionStatisticsItem: + properties: + import: + type: integer + example: 0 + email: + type: integer + example: 0 + www: + type: integer + example: 0 + panel: + type: integer + example: 0 + leads: + type: integer + example: 0 + sale: + type: integer + example: 0 + api: + type: integer + example: 0 + forward: + type: integer + example: 0 + survey: + type: integer + example: 0 + mobile: + type: integer + example: 0 + copy: + type: integer + example: 0 + landing_page: + type: integer + example: 0 + webinar: + type: integer + example: 0 + summary: + type: integer + example: 0 + type: object + CampaignSummaryList: + type: array + items: + $ref: '#/components/schemas/CampaignSummaryItem' + CampaignLocationsList: + type: array + items: + $ref: '#/components/schemas/CampaignLocationItem' + RemovalsByDatesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignRemovalsStatisticsList' + CampaignRemovalsStatisticsList: + type: object + example: + '2014-12-05': + user: 5 + '2015-01-22': + user: 12 + bounce: 2 + additionalProperties: + description: Dates in YYYY-MM-DD format are used as keys + $ref: '#/components/schemas/CampaignRemovalsStatisticsItem' + CampaignLocationItem: + type: object + example: + others: + amount: '6' + continentCode: '' + countryCode: '' + PL: + amount: '45' + continentCode: EU + countryCode: PL + additionalProperties: + description: The results are indexed with the location name (PL, EN, etc.) + properties: + amount: + description: The amount of subscribers from a given location + type: string + format: number + example: '0' + continentalCode: + description: The region code + type: string + example: EU + countryCode: + description: The country code + type: string + example: PL + type: object + CampaignOriginsList: + type: array + items: + $ref: '#/components/schemas/CampaignSubscriptionStatisticsItemByCampaign' + CampaignListSizesStatisticsElement: + properties: + totalSubscribers: + description: The total amount of subscribers for a given datetime and grouping + type: integer + format: int64 + addedSubscribers: + description: The amount of subscribers added since the previous statistics frame + type: integer + format: int64 + removedSubscribers: + description: >- + The amount of subscribers removed since the previous statistics + frame + type: integer + format: int64 + createdOn: + description: >- + The statistics frame timestamp. The value depends on the groupBy + parameter. For the hour, use datetime in the format YYYY-mm-dd + HH:mm:ss; for the day, use date in the format YYYY-mm-dd; for the + month, use a string in the format YYYY-mm; and for the total, use + the string total. + type: string + type: object + CampaignListSizesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignListSizesStatisticsElement' + BalanceByDatesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignBalanceStatisticsList' + CampaignBalanceStatisticsList: + type: object + example: + '2014-12-05': + removals: + user: 5 + subscriptions: + import: 0 + email: 0 + www: 0 + panel: 0 + leads: 0 + sale: 0 + api: 7 + forward: 0 + survey: 0 + mobile: 0 + copy: 0 + landing_page: 0 + summary: 7 + '2015-01-21': + removals: + user: 10 + additionalProperties: + description: Dates in YYYY-MM-DD format are used as keys + anyOf: + - properties: + removals: + type: object + allOf: + - $ref: '#/components/schemas/CampaignRemovalsStatisticsItem' + type: object + - properties: + subscriptions: + type: object + allOf: + - $ref: '#/components/schemas/CampaignSubscriptionStatisticsItem' + type: object + CampaignSummaryItem: + description: >- + The properties of the result are indexed with the location name (PL, EN, + etc.). + type: object + example: + o5lx: + totalSubscribers: '4' + totalNewsletters: '129' + totalTriggers: '0' + totalLandingPages: '1' + totalWebforms: '3' + CC9F: + totalSubscribers: '0' + totalNewsletters: '0' + totalTriggers: '0' + totalLandingPages: '5' + totalWebforms: '0' + V6OeR: + totalSubscribers: '0' + totalNewsletters: '0' + totalTriggers: '0' + totalLandingPages: '0' + totalWebforms: '0' + additionalProperties: + properties: + totalSubscribers: + description: The total number of subscribers + type: string + format: number + example: '0' + totalNewsletters: + description: The total number of newsletters + type: string + format: number + example: '0' + totalTriggers: + description: The total number of triggers + type: string + format: number + example: '0' + totalLandingPages: + description: The total number of landing pages + type: string + format: number + example: '0' + totalWebforms: + description: The total number of webforms + type: string + format: number + example: '0' + type: object + CampaignListElement: + properties: + description: + description: It's the same as the campaign name, kept for compatibility reasons + type: string + readOnly: true + example: my_campaign + type: object + allOf: + - $ref: '#/components/schemas/BaseCampaign' + CampaignReference: + required: + - campaignId + properties: + campaignId: + description: Campaign ID + type: string + example: C + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/campaigns/C + name: + description: The campaign name + type: string + readOnly: true + example: Promo campaign + nullable: true + type: object + CampaignStatisticsIdQuery: + type: string + example: 3Va2e + LegacyForm: + properties: + webformId: + description: The webform (Legacy Form) ID + type: string + example: NPKx + name: + type: string + example: Webform 2010/7/5 + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/webforms/NPKx + scriptUrl: + description: The URL of the script that displays the Legacy Form + type: string + format: uri + example: https://app.getresponse.com/view_webform.js?u=VfEy1&wid=11774901 + status: + $ref: '#/components/schemas/StatusEnum' + modifiedOn: + description: The modification date + type: string + format: date-time + statistics: + $ref: '#/components/schemas/LegacyFormStatistics' + campaign: + $ref: '#/components/schemas/CampaignReference' + type: object + LegacyFormStatistics: + properties: + opened: + description: The number of Legacy Form views + type: integer + format: int64 + example: 1234 + subscribed: + description: The number of contacts that subscribed using this Legacy Form + type: integer + format: int64 + example: 100 + type: object + GDPRField: + properties: + gdprFieldId: + type: string + readOnly: true + example: MtY + name: + description: The name of the GDPR field + type: string + example: 'Consent #1' + createdOn: + type: string + format: date-time + example: 2018-08-01T09:18:00+0000 + href: + description: The direct hyperlink to the resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/gdpr-fields/MtY + type: object + GDPRFieldLatestVersion: + properties: + gdprFieldVersionId: + type: string + readOnly: true + example: yRI + content: + description: The content of the GDPR field + type: string + readOnly: true + example: '1st version of Consent #1' + createdOn: + type: string + format: date-time + example: 2018-08-02T11:12:00+0000 + type: object + GDPRFieldDetails: + type: object + allOf: + - $ref: '#/components/schemas/GDPRField' + - properties: + latestVersion: + $ref: '#/components/schemas/GDPRFieldLatestVersion' + type: object + UpdateWorkflow: + required: + - status + properties: + status: + description: >- + An 'incomplete' status means that the workflow is a 'draft' in the + web panel + type: string + enum: + - active + - inactive + - incomplete + example: active + type: object + Workflow: + required: + - workflowId + - name + - status + - subscriberStatistics + properties: + workflowId: + description: The workflow ID + type: string + readOnly: true + example: pxs + name: + type: string + example: My draft + status: + type: string + enum: + - active + - inactive + - incomplete + example: active + dateStart: + type: string + format: date-time + example: 2014-02-12T15:19:21+0000 + dateStop: + type: string + format: date-time + example: 2014-04-12T15:19:21+0000 + subscriberStatistics: + $ref: '#/components/schemas/WorkflowSubscriberStatistics' + type: object + WorkflowSubscriberStatistics: + required: + - completedCount + - inProgressCount + properties: + completedCount: + description: The number of subscribers that completed the workflow + type: integer + format: int64 + readOnly: true + example: 4 + inProgressCount: + description: The number of subscribers that are in progress in the workflow + type: integer + format: int64 + readOnly: true + example: 3 + type: object + SmsDetails: + properties: + sendSettings: + description: How the message will be delivered to the subscriber + type: object + nullable: true + allOf: + - properties: + contacts: + description: >- + The details of recipients who are in your contact list + (recipientsType = \"contacts\"). If the recipient is not in + your GetResponse contacts, the property is null. + nullable: true + allOf: + - properties: + selectedCampaigns: + $ref: >- + #/components/schemas/MessageSendSettingSelectedCampaigns + selectedSegments: + $ref: >- + #/components/schemas/MessageSendSettingSelectedSegments + excludedCampaigns: + $ref: >- + #/components/schemas/MessageSendSettingExcludedCampaigns + excludedSegments: + $ref: >- + #/components/schemas/MessageSendSettingExcludedSegments + selectedContacts: + description: The list of contact IDs. + items: + type: string + example: V2 + type: object + importedNumbers: + description: >- + The details of recipients whose numbers are imported + (recipientsType = \"importedNumbers\"). If the recipient is + in your GetResponse contacts, the property is null. + nullable: true + allOf: + - properties: + count: + description: Number of phone numbers entered manually + type: integer + example: 10 + type: object + type: object + clickTracks: + description: >- + Details of links attached to SMS message. Maximum 20 links will be + returned. + type: array + items: + allOf: + - properties: + clickTrackId: + description: The click track ID + type: string + example: a2 + href: + description: Direct hyperlink to a resource + type: string + example: https://api.getresponse.com/v3/click-tracks/a2 + url: + description: The link URL + type: string + example: https://example.com + label: + description: The link label + type: string + example: example-link + amount: + description: Number of clicks on a link + type: integer + example: 2 + uniqueAmount: + description: Number of unique clicks on link + type: integer + example: 1 + type: object + type: object + allOf: + - $ref: '#/components/schemas/SmsListItem' + SmsAutomationListItem: + required: + - smsId + properties: + smsId: + description: The automated SMS message ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/sms-automation/N + name: + description: The automated SMS message name + type: string + maxLength: 128 + minLength: 2 + example: New message + campaign: + description: The campaign the SMS message is in + allOf: + - $ref: '#/components/schemas/CampaignReference' + modifiedOn: + description: >- + The date the automated SMS message was last modified on, shown in + `ISO 8601` date and time format. e.g. `2022-04-10T10:02:57+0000` + type: string + format: date-time + status: + description: The status of of the automated SMS message + type: string + enum: + - ready + - in_use + statistics: + description: Automate SMS message statistics + allOf: + - properties: + sent: + description: The number od sent automated SMS messages + type: integer + example: 12 + delivered: + description: The number of delivered automated SMS messages + type: integer + example: 10 + clicks: + description: The number of automated SMS link clicks + type: integer + example: 8 + type: object + senderName: + description: The name of the sender of the automated SMS message + type: string + readOnly: true + hasLinks: + description: Information is the automated SMS message contains links + type: boolean + readOnly: true + type: object + SmsListItem: + required: + - newsletterId + - href + properties: + smsId: + description: The SMS message ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/sms/N + name: + description: The SMS message name + type: string + maxLength: 128 + minLength: 2 + example: New message + campaign: + description: The SMS message campaign + allOf: + - $ref: '#/components/schemas/CampaignReference' + modifiedOn: + description: >- + The date the SMS message was last modified on, shown in `ISO 8601` + date and time format. e.g. `2022-04-10T10:02:57+0000` + type: string + format: date-time + type: + description: The SMS message type + type: string + enum: + - sms + - draft + readOnly: true + sendOn: + description: SMS message send date details + type: object + nullable: true + allOf: + - properties: + date: + description: >- + Send date. Shown in format `ISO 8601` without timezone + offset e.g. `2022-04-10T10:02:57`. + type: string + format: date-time + example: '2022-03-26T10:35:00' + timeZone: + description: Time zone details + type: object + allOf: + - properties: + timeZoneId: + description: Time zone ID + type: integer + example: '123' + timeZoneName: + description: Time zone name + type: string + example: America/New_York + timeZoneOffset: + description: Time zone offset + type: string + example: '-05:00' + type: object + type: object + recipientsType: + description: Type of SMS message recipients + type: string + enum: + - contacts + - importedNumbers + readOnly: true + example: contacts + senderName: + description: The SMS message sender name + type: string + readOnly: true + content: + description: The SMS message content + type: string + example: This is my SMS content + sendMetrics: + description: Information about sending process + type: object + allOf: + - properties: + progress: + description: Sending progress + type: string + status: + description: Sending status + type: string + enum: + - scheduled + - sending + - sent + type: object + statistics: + description: Message statistics + allOf: + - properties: + sent: + description: Number of sent messages + type: integer + example: 12 + delivered: + description: Number of delivered messages + type: integer + example: 10 + clicks: + description: Number of clicked messages + type: integer + example: 8 + type: object + type: object + AutoresponderDetails: + properties: + clickTracks: + description: The list of tracked links + type: array + items: + $ref: '#/components/schemas/ClickTrack' + campaign: + description: The autoresponder campaign (list) + allOf: + - $ref: '#/components/schemas/CampaignReference' + type: object + allOf: + - $ref: '#/components/schemas/Autoresponder' + AutoresponderList: + type: array + items: + properties: + campaign: + description: The autoresponder campaign (list) + allOf: + - $ref: '#/components/schemas/CampaignReference' + type: object + allOf: + - $ref: '#/components/schemas/Autoresponder' + Website: + properties: + websiteId: + description: The website ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/websites/6b0d7d59-71d9-4708-80a6-aa0f13805111 + name: + description: The website name + type: string + example: 'Predesigned #017' + status: + description: The website status + type: string + enum: + - published + - unpublished + readOnly: true + domainUrl: + description: The website domain + type: string + format: uri + readOnly: true + example: predesigned-017-52612.grweb.site + thumbnailUrl: + description: The URL of a website thumbnail + type: string + format: uri + readOnly: true + example: >- + https://us-wbe-img2.gr-cdn.com/user/e5c2094a-2354-459f-9b9f-6d0369ccae2c/6b0d7d59-71d9-4708-80a6-aa0f13805111.png?width=208 + isChatsEnabled: + description: Chats is enabled on the website + example: true + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + createdAt: + description: The date the website was created + type: string + format: date-time + updatedAt: + description: The date the website was updated + type: string + format: date-time + statistics: + description: The website statistics + $ref: '#/components/schemas/WebsiteStatistics' + type: object + WebsiteStatistics: + properties: + pageViews: + description: Number of page views + type: integer + format: int64 + example: 9 + visits: + description: Number of site visits + type: integer + format: int64 + example: 5 + uniqueVisitors: + description: Number of unique visitors + type: integer + format: int64 + example: 5 + type: object + WebsiteStats: + required: + - websiteId + properties: + websiteId: + description: The website ID + type: string + example: PvLI8C + name: + type: string + example: Variant A + pageViews: + description: The number of page views + type: integer + example: 1 + visits: + description: The number of visits + type: integer + example: 1 + uniqueVisitors: + description: The number of unique visitors + type: integer + example: 1 + thumbnailUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/wbe/N + type: object + WebsiteDetails: + type: object + allOf: + - $ref: '#/components/schemas/Website' + - properties: + pages: + type: array + items: + $ref: '#/components/schemas/WebsitePage' + type: object + WebsitePage: + properties: + uuid: + description: The website page ID + type: string + readOnly: true + example: 6ee7597f-9bde-4b92-9411-2fb228c9fa34 + name: + description: The website page name + type: string + example: Home + status: + description: The website page status + type: string + enum: + - active + - inactive + url: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: /terms-of-service + redirectUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: '' + createdAt: + description: The date the website page was created + type: string + format: date-time + type: object + responses: + WebinarDetails: + description: The webinar details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Webinar' + WebinarList: + description: The list of webinars + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Webinar' + UpsertContactTags: + description: ' The list of contact tags.' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactTag' + ContactActivityList: + description: The list of contact activities. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactActivity' + ContactCustomFieldList: + description: The list of custom fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactCustomFieldList' + ContactList: + description: The list of contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactListElement' + ContactDetails: + description: The contact details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactDetails' + BaseSearchContactsList: + description: The saved search contact. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BaseSearchContactsDetails' + SearchContactsDetails: + description: Search contact details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SearchContactsDetails' + SearchedContactsList: + description: The contact list. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SearchedContactDetails' + TransactionalEmailsTemplateDetails: + description: Transactional emails template details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionalEmailsTemplateDetails' + TransactionalEmailsTemplateList: + description: Transactional email templates listing + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailsTemplateListElement' + TransactionalEmailDetails: + description: Transactional email details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionalEmailDetails' + TransactionalEmailStatistics: + description: The overall statistics of transactional emails + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailStatistics' + TransactionalEmailList: + description: The list of transactional emails + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailListElement' + TransactionalEmail: + description: Transactional email. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionalEmail' + FromFieldList: + description: The list of 'From' email addresses ('from fields'). + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FromField' + FromFieldDetails: + description: The 'From' address details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/FromField' + RssNewsletterDetails: + description: The RSS newsletter details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/RssNewsletterDetails' + RssNewsletterList: + description: The list of RSS newsletters. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RssNewsletterListItem' + TaxDetails: + description: The tax details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Tax' + TaxList: + description: The list of taxes + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tax' + CustomEventDetails: + description: The custom event details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEventDetails' + CustomEventsList: + description: The list of custom events + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomEventDetails' + FormVariantList: + description: The list of form variants. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FormVariantDetails' + FormDetails: + description: The form details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/FormDetails' + FormList: + description: The list of forms. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Form' + LandingPageList: + description: The list of landing pages. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BaseLandingPage' + LandingPageDetails: + description: The landing pages details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LandingPage' + ImportList: + description: The list of imports. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Import' + ImportDetails: + description: The import details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Import' + SmsStats: + description: SMS statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsStats' + RevenueStats: + description: Revenue statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/RevenueStatistics' + GeneralPerformanceStats: + description: General performance statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/GeneralPerformanceStats' + PredefinedFieldsList: + description: The list of predefined fields. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PredefinedField' + PredefinedFieldDetails: + description: The predefined field details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/PredefinedField' + CategoryDetails: + description: The category details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Category' + CategoryList: + description: The list of categories + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Category' + SuppressionsList: + description: The suppressions list. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Suppression' + SuppressionDetails: + description: The suppression details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SuppressionDetails' + OrderList: + description: The list of orders + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Order' + OrderDetails: + description: The order details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + SubscriptionConfirmationBodyList: + description: List of subscription confirmation bodies + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SubscriptionConfirmationBody' + SubscriptionConfirmationSubjectList: + description: List of subscription confirmation subjects + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SubscriptionConfirmationSubject' + ProductList: + description: The list of products + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Product' + SimpleProductCategoryList: + description: The list of product categories + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BaseCategory' + ProductDetails: + description: The product details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Product' + ShopList: + description: The list of shops + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + properties: + shopId: + description: The shop ID + type: string + readOnly: true + example: pf3 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3 + name: + description: The shop name + type: string + maxLength: 124 + minLength: 4 + example: Monster market + locale: + description: The language locale (ISO 639-1) + type: string + example: PL + currency: + description: The currency code (ISO 4217) + type: string + example: PLN + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + ShopDetails: + description: The shop details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ShopDetails' + PopupGeneralPerformance: + description: Form or popup statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/PopupGeneralPerformanceStats' + PopupDetails: + description: Form or popup details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/PopupDetails' + PopupsList: + description: The list of forms and popups + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PopupListItem' + SplittestList: + description: The list of A/B tests. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Splittest' + Splittest: + description: A/B test details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Splittest' + CartDetails: + description: The cart details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + CartList: + description: The list of carts + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Cart' + Quota: + description: Storage space information + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Quota' + FileList: + description: The list of files + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/File' + File: + description: The file details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/File' + Folder: + description: The folder details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Folder' + FoldersList: + description: The list of folders + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Folder' + AbtestsSubjectGetDetails: + description: A/B test details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AbtestsSubjectDetails' + AbtestsSubjectGetList: + description: The list of A/B tests + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AbtestsSubjectListItem' + ClickTrack: + description: The click track details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ClickTrackResource' + ClickTrackList: + description: The list of click tracks + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClickTrackResource' + MessageStatisticsListElement: + description: The message statistics. + content: + application/json: + schema: + $ref: '#/components/schemas/MessageStatisticsListElement' + NewsletterDetails: + description: The newsletter details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/NewsletterDetails' + NewsletterList: + description: The list of newsletters. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NewsletterListElement' + NewsletterActivities: + description: The list of newsletters activities + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NewsletterActivity' + TagDetails: + description: The tag details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TagDetails' + TagList: + description: The list of tags + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tag' + AddressList: + description: The list of addresses. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Address' + AddressDetails: + description: The address details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Address' + AccountBlocklist: + description: Blocklist masks for the whole account. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Blocklist' + CampaignBlocklist: + description: Blocklist masks for the campaign. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Blocklist' + CustomFieldDetails: + description: The custom field details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CustomField' + CustomFieldList: + description: The list of custom fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomField' + LpsList: + description: The list of tags + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Lps' + LpsDetails: + description: The landing page details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/LpsDetails' + LpsStats: + description: Landing page statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/LpsStats' + ImageList: + description: Image list + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ImageDetails' + ImageDetails: + description: Image details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ImageDetails' + Tracking: + description: The Tracking Snippets + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tracking' + FacebookPixelList: + description: '"Facebook Pixel" details' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FacebookPixel' + ProductVariantDetails: + description: The product variant details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ProductVariant' + ProductVariantList: + description: The list of product variants + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProductVariant' + AccountBadgeDetails: + description: Account badge status + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AccountBadgeDetails' + SendingLimitsList: + description: Send limits + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SendingLimitsListItem' + IndustryList: + description: Industry tags list + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IndustryTag' + AccountTimezoneList: + description: List of time zones + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Timezone' + AccountLoginHistoryList: + description: Login history information + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AccountsLoginHistoryListElement' + Callback: + description: Callback configuration + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Callback' + AccountDetails: + description: Your account information + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Account' + AccountBillingDetails: + description: Billing information. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AccountBilling' + SubscriptionsByDatesStatisticsList: + description: Subscription statistics by date + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionsByDatesStatisticsList' + CampaignSummaryList: + description: The summary list. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignSummaryList' + CampaignLocationsList: + description: The list of locations. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignLocationsList' + RemovalsByDatesStatisticsList: + description: Subscription statistics by date + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/RemovalsByDatesStatisticsList' + CampaignOriginsList: + description: The list of origins. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignOriginsList' + CampaignListSizesStatisticsList: + description: The campaign data. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignListSizesStatisticsList' + BalanceByDatesStatisticsList: + description: The subscription statistics, shown by date. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/BalanceByDatesStatisticsList' + Campaign: + description: The campaign data. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Campaign' + CampaignList: + description: The list of campaigns. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CampaignListElement' + MetaFieldDetails: + description: The meta field details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/MetaField' + MetaFieldList: + description: The list of meta fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetaField' + LegacyForm: + description: The Legacy Form. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/LegacyForm' + LegacyFormList: + description: The list of Legacy Forms. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LegacyForm' + GDPRFieldList: + description: The list of GDPR fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GDPRField' + GDPRFieldDetails: + description: The details of the GDPR field + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/GDPRFieldDetails' + Workflow: + description: The workflow + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Workflow' + WorkflowList: + description: The list of workflows + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Workflow' + SmsDetails: + description: The SMS message details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsDetails' + SmsAutomationList: + description: The list of the automated SMS messages + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsAutomationListItem' + SmsList: + description: The SMS message listing + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsListItem' + MessageStatisticsList: + description: The list of autoresponders statistic split by time interval. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MessageStatisticsListElement' + SingleMessageStatisticsList: + description: The list of autoresponder statistics split by time interval. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MessageStatisticsListElement' + AutoresponderDetails: + description: The autoresponder details' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AutoresponderDetails' + AutoresponderList: + description: The list of autoresponders. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/AutoresponderList' + WebsitesList: + description: The list of tags + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Website' + WebsiteStats: + description: Website statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/WebsiteStats' + WebsiteDetails: + description: The website details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/WebsiteDetails' + parameters: + webinarId: + name: webinarId + in: path + description: The webinar ID + required: true + schema: + type: string + example: yK6d + contactId: + name: contactId + in: path + description: The contact ID + required: true + schema: + type: string + example: pV3r + searchContactId: + name: searchContactId + in: path + description: The saved search contact identifier + required: true + schema: + type: string + example: pV3r + transactionalTemplateId: + name: transactionalTemplateId + in: path + description: Transactional emails template identifier + required: true + schema: + type: string + example: abc + transactionalEmailId: + name: transactionalEmailId + in: path + required: true + schema: + type: string + example: tRe4i + fromFieldId: + name: fromFieldId + in: path + description: The 'From' address ID + required: true + schema: + type: string + example: TTzW + rssNewsletterId: + name: rssNewsletterId + in: path + description: The RSS newsletter ID + required: true + schema: + type: string + example: dGer + taxId: + name: taxId + in: path + description: The tax ID + required: true + schema: + type: string + example: Sk + customEventId: + name: customEventId + in: path + description: The custom event ID + required: true + schema: + type: string + example: hp2 + formId: + name: formId + in: path + description: The form ID + required: true + schema: + type: string + example: pL4e + landingPageId: + name: landingPageId + in: path + description: The landing page ID. + required: true + schema: + type: string + example: avYn + importId: + name: importId + in: path + description: The import ID + required: true + schema: + type: string + example: o6gE + predefinedFieldId: + name: predefinedFieldId + in: path + description: The predefined field identifier + required: true + schema: + type: string + example: 6neM + categoryId: + name: categoryId + in: path + description: The category ID + required: true + schema: + type: string + example: C3s + suppressionId: + name: suppressionId + in: path + description: The suppression ID + required: true + schema: + type: string + example: pypF + orderId: + name: orderId + in: path + description: The order ID + required: true + schema: + type: string + example: fOh + languageCode: + name: languageCode + in: path + description: ISO 639-1 Language Code Standard + required: true + schema: + type: string + example: en + productId: + name: productId + in: path + description: The product ID + required: true + schema: + type: string + example: 9I + shopId: + name: shopId + in: path + description: The shop ID + required: true + schema: + type: string + example: pf3 + popupId: + name: popupId + in: path + description: The form or popup ID + required: true + schema: + type: string + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + splittestId: + name: splittestId + in: path + description: The send settings for the A/B test + required: true + schema: + type: string + example: 9I + cartId: + name: cartId + in: path + description: The cart ID + required: true + schema: + type: string + example: V + fileId: + name: fileId + in: path + description: The file ID + required: true + schema: + type: string + example: 6Yh + folderId: + name: folderId + in: path + description: The folder ID + required: true + schema: + type: string + example: Pa5 + abTestId: + name: abTestId + in: path + description: A/B test ID + required: true + schema: + type: string + example: xyz + clickTrackId: + name: clickTrackId + in: path + required: true + schema: + type: string + example: C12t + newsletterId: + name: newsletterId + in: path + description: The newsletter ID + required: true + schema: + type: string + example: 'N' + tagId: + name: tagId + in: path + description: The tag ID + required: true + schema: + type: string + example: vBd5 + addressId: + name: addressId + in: path + description: The address ID + required: true + schema: + type: string + example: k9 + customFieldId: + name: customFieldId + in: path + description: The custom field ID + required: true + schema: + type: string + example: pas + lpsId: + name: lpsId + in: path + description: The landing page ID + required: true + schema: + type: string + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + variantId: + name: variantId + in: path + description: The variant ID + required: true + schema: + type: string + example: VTB + campaignId: + name: campaignId + in: path + description: The campaign ID + required: true + schema: + type: string + example: 3Va2e + CampaignStatisticsIdQuery: + name: query[campaignId] + in: query + required: true + schema: + $ref: '#/components/schemas/CampaignStatisticsIdQuery' + CampaignStatisticsGroupByQuery: + name: query[groupBy] + in: query + required: false + schema: + type: string + enum: + - hour + - day + - month + - total + example: month + CampaignStatisticsDateFromQuery: + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + CampaignStatisticsDateToQuery: + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + metaFieldId: + name: metaFieldId + in: path + description: The metafield ID + required: true + schema: + type: string + example: hgF + webformId: + name: webformId + in: path + description: The webform (Legacy Form) ID + required: true + schema: + type: string + example: 3Va2e + gdprFieldId: + name: gdprFieldId + in: path + description: The GDPR field ID + required: true + schema: + type: string + example: MtY + workflowId: + name: workflowId + in: path + description: The workflow ID + required: true + schema: + type: string + example: 3Va2e + smsId: + name: smsId + in: path + description: The SMS message ID + required: true + schema: + type: string + example: 'N' + autoresponderId: + name: autoresponderId + in: path + description: The autoresponder ID. + required: true + schema: + type: string + example: Q + websiteId: + name: websiteId + in: path + description: The website ID + required: true + schema: + type: string + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + PerPage: + name: perPage + in: query + description: Requested number of results per page + required: false + schema: + type: integer + format: int32 + default: 100 + maximum: 1000 + minimum: 1 + Page: + name: page + in: query + description: Page number + required: false + schema: + type: integer + format: int32 + default: 1 + minimum: 1 + Fields: + name: fields + in: query + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + required: false + schema: + type: string + requestBodies: + NewShop: + content: + application/json: + schema: + $ref: '#/components/schemas/NewShop' + NewCategory: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCategory' + UpdateCategory: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCategory' + UpdateShop: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateShop' + NewMetaField: + content: + application/json: + schema: + $ref: '#/components/schemas/NewMetaField' + NewProduct: + content: + application/json: + schema: + $ref: '#/components/schemas/NewProduct' + UpdateProduct: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateProduct' + UpsertProductCategory: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertProductCategory' + UpsertMetaField: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertMetaField' + UpdateMetaField: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMetaField' + NewProductVariant: + content: + application/json: + schema: + $ref: '#/components/schemas/NewProductVariant' + UpdateProductVariant: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateProductVariant' + NewTax: + content: + application/json: + schema: + $ref: '#/components/schemas/NewTax' + UpdateTax: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateTax' + NewAddress: + content: + application/json: + schema: + $ref: '#/components/schemas/NewAddress' + UpdateAddress: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAddress' + NewOrder: + content: + application/json: + schema: + $ref: '#/components/schemas/NewOrder' + UpdateOrder: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateOrder' + NewCart: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCart' + UpdateCart: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCart' + NewSearchContacts: + content: + application/json: + schema: + $ref: '#/components/schemas/NewSearchContacts' + UpdateSearchContacts: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSearchContacts' + SearchContactsConditionsDetails: + content: + application/json: + schema: + $ref: '#/components/schemas/SearchContactsConditionsDetails' + CreateTransactionalEmail: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTransactionalEmail' + CreateTransactionalEmailTemplate: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTransactionalEmailTemplate' + updateTransactionalEmailsTemplate: + content: + application/json: + schema: + properties: + subject: + description: The template subject + type: string + example: Order Confirmation - Example Shop + content: + $ref: '#/components/schemas/TransactionalEmailTemplateContent' + type: object + NewFromField: + content: + application/json: + schema: + $ref: '#/components/schemas/NewFromField' + NewCampaign: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCampaign' + UpdateCampaign: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCampaign' + UpdateAccount: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAccount' + NewAutoresponder: + content: + application/json: + schema: + $ref: '#/components/schemas/NewAutoresponder' + UpdateAutoresponder: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAutoresponder' + NewRssNewsletter: + content: + application/json: + schema: + $ref: '#/components/schemas/NewRssNewsletter' + UpdateRssNewsletter: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRssNewsletter' + NewContact: + content: + application/json: + schema: + $ref: '#/components/schemas/NewContact' + UpsertContactCustomFields: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertContactCustomFields' + UpsertContactTags: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertContactTags' + UpdateContact: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateContact' + NewCustomField: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCustomField' + UpdateCustomField: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCustomField' + NewSuppression: + content: + application/json: + schema: + $ref: '#/components/schemas/NewSuppression' + UpdateSuppression: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSuppression' + NewPredefinedField: + content: + application/json: + schema: + $ref: '#/components/schemas/NewPredefinedField' + UpdatePredefinedField: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePredefinedField' + UpdateCallbacks: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCallbacks' + TriggerCustomEvent: + content: + application/json: + schema: + $ref: '#/components/schemas/TriggerCustomEvent' + NewCustomEvent: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCustomEvent' + UpdateCustomEvent: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCustomEvent' + NewImport: + content: + application/json: + schema: + $ref: '#/components/schemas/NewImport' + NewFile: + content: + application/json: + schema: + $ref: '#/components/schemas/NewFile' + NewFolder: + content: + application/json: + schema: + $ref: '#/components/schemas/NewFolder' + NewAbtestsSubject: + content: + application/json: + schema: + $ref: '#/components/schemas/NewAbtestsSubject' + ChooseWinnerAbtestsSubject: + content: + application/json: + schema: + $ref: '#/components/schemas/ChooseWinnerAbtestsSubject' + SendNewsletterDraft: + content: + application/json: + schema: + $ref: '#/components/schemas/SendNewsletterDraft' + NewNewsletter: + content: + application/json: + schema: + $ref: '#/components/schemas/NewNewsletter' + NewTag: + content: + application/json: + schema: + $ref: '#/components/schemas/NewTag' + UpdateTag: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateTag' + UpdateAccountBlocklist: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlocklist' + UpdateCampaignBlocklist: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlocklist' + CreateMultimedia: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/CreateMultimedia' + UpdateAccountBadge: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAccountBadge' + UpdateWorkflow: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateWorkflow' + headers: + CurrentPage: + description: The current page number + schema: + type: integer + format: int32 + TotalPages: + description: The total number of pages + schema: + type: integer + format: int32 + TotalCount: + description: The total number of resources found for the specified conditions + schema: + type: integer + format: int32 + RateLimitLimit: + description: The total number of requests available per time frame + schema: + type: integer + format: int32 + RateLimitRemaining: + description: The number of requests left in the current time frame + schema: + type: integer + format: int32 + RateLimitReset: + description: Seconds left in the current time frame, e.g. "432 seconds" + schema: + type: string + securitySchemes: + api-key: + type: apiKey + description: Header value must be prefixed with api-key + name: X-Auth-Token + in: header + oauth2: + type: oauth2 + flows: + implicit: + authorizationUrl: https://app.getresponse.com/oauth2_authorize.html + scopes: + all: all data access + authorizationCode: + authorizationUrl: https://app.getresponse.com/oauth2_authorize.html + tokenUrl: https://api.getresponse.com/v3/token + scopes: + all: all data access + clientCredentials: + tokenUrl: https://api.getresponse.com/v3/token + scopes: + all: all data access + tags: + - name: Webinars + - name: Contacts + - name: Search Contacts + - name: Transactional Email Templates + - name: Transactional Emails + - name: From Fields + - name: RSS Newsletters + - name: Taxes + - name: Custom Events + - name: Forms + - name: Legacy Landing Pages + - name: Imports + - name: Predefined Fields + - name: Categories + - name: Suppressions + - name: Orders + - name: Subscription Confirmations + - name: Products + - name: Shops + - name: Forms and Popups + - name: A/B tests + - name: Carts + - name: File Library + - name: A/B tests - subject + - name: Click Tracks + description: >- + Click tracking refers to the data collected about each link click, such as + how many people clicked it, how many clicks resulted in desired actions + such as sales, forwards or subscriptions. + - name: Newsletters + - name: Tags + - name: Addresses + - name: Custom Fields + - name: New Landing Pages + - name: Multimedia + - name: Tracking + - name: Product Variants + - name: Accounts + - name: Campaigns (Lists) + description: >- + Our API v3 uses the terminology from the previous version of GetResponse. + + + **Campaigns and lists are the same resource under a different name.** For + now, please refer to lists as campaigns. + + + Our API v4 will use the updated terminology. + - name: Meta Fields + - name: Legacy Forms + - name: Workflows + - name: SMS Automation Messages + - name: SMS Messages + - name: Autoresponders + - name: Websites + externalDocs: + description: Find out more about API + url: https://apidocs.getresponse.com + x-tagGroups: + - name: User + tags: + - Accounts + - Multimedia + - File Library + - name: Contacts + tags: + - Campaigns (Lists) + - Contacts + - Custom Fields + - Search Contacts + - Subscription Confirmations + - Predefined Fields + - Suppressions + - Imports + - name: Email Marketing + tags: + - Newsletters + - Autoresponders + - RSS Newsletters + - Legacy Landing Pages + - From Fields + - A/B tests + - A/B tests - subject + - Click Tracks + - name: Tags + tags: + - Tags + - name: GDPR Fields + tags: + - GDPR Fields + - name: Forms and surveys + tags: + - Legacy Forms + - Forms + - name: Automation + tags: + - Workflows + - Custom Events + - Tracking + - name: Ecommerce + tags: + - Addresses + - Carts + - Categories + - Meta Fields + - Orders + - Products + - Product Variants + - Shops + - Taxes + - name: Transactional Emails + tags: + - Transactional Emails + - Transactional Emails Templates + - name: SMS + tags: + - SMS Messages + - SMS Automation Messages + - name: Statistics + tags: + - Ecommerce + - Sms + - Website + - Landing Page + - Form and Popup + - name: Webinars + tags: + - Webinars + - name: Websites + tags: + - Websites + - Landing Pages + - name: Forms and Popups + tags: + - Forms and Popups +konfigCliVersion: 1.38.34 diff --git a/sdks/db/fixed-specs/box-fixed-spec.yaml b/sdks/db/fixed-specs/box-fixed-spec.yaml index 669b89856b..f5de4f470b 100644 --- a/sdks/db/fixed-specs/box-fixed-spec.yaml +++ b/sdks/db/fixed-specs/box-fixed-spec.yaml @@ -458,7 +458,6 @@ paths: - Authorization summary: Authorize user operationId: get_authorize - security: [] description: |- Authorize a user by sending them through the [Box](https://box.com) website and request their permission to act on their behalf. @@ -18209,7 +18208,6 @@ paths: - Zip Downloads summary: Download zip archive operationId: ZipDownloads_getContentById - security: [] description: >- Returns the contents of a `zip` archive in binary format. This URL does not diff --git a/sdks/db/fixed-specs/digital-ocean-fixed-spec.yaml b/sdks/db/fixed-specs/digital-ocean-fixed-spec.yaml index d05cbb9161..461906765c 100644 --- a/sdks/db/fixed-specs/digital-ocean-fixed-spec.yaml +++ b/sdks/db/fixed-specs/digital-ocean-fixed-spec.yaml @@ -1485,9 +1485,6 @@ paths: - 1-Click Applications summary: List 1-Click Applications operationId: oneClicks_list - security: - - bearer_auth: - - read description: > To list all available 1-Click applications, send a GET request to `/v2/1-clicks`. The `type` may @@ -1634,9 +1631,6 @@ paths: - SSH Keys summary: List All SSH Keys operationId: sshKeys_list - security: - - bearer_auth: - - read description: >- To list all of the keys in your account, send a GET request to `/v2/account/keys`. The response will be a JSON object with a key set to @@ -1791,9 +1785,6 @@ paths: - SSH Keys summary: Retrieve an Existing SSH Key operationId: sshKeys_get - security: - - bearer_auth: - - read description: >- To get information about a key, send a GET request to `/v2/account/keys/$KEY_ID` or `/v2/account/keys/$KEY_FINGERPRINT`. @@ -1859,9 +1850,6 @@ paths: - SSH Keys summary: Update an SSH Key's Name operationId: sshKeys_update - security: - - bearer_auth: - - write description: >- To update the name of an SSH key, send a PUT request to either `/v2/account/keys/$SSH_KEY_ID` or @@ -1943,9 +1931,6 @@ paths: - SSH Keys summary: Delete an SSH Key operationId: sshKeys_delete - security: - - bearer_auth: - - write description: >- To destroy a public SSH key that you have in your account, send a DELETE request to `/v2/account/keys/$KEY_ID` or @@ -2013,9 +1998,6 @@ paths: - Actions summary: List All Actions operationId: actions_list - security: - - bearer_auth: - - read description: >- This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, @@ -2084,9 +2066,6 @@ paths: - Actions summary: Retrieve an Existing Action operationId: actions_get - security: - - bearer_auth: - - read description: >- To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_ID`. @@ -2150,9 +2129,6 @@ paths: - Apps summary: List All Apps operationId: apps_list - security: - - bearer_auth: - - read description: >- List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for @@ -2192,9 +2168,6 @@ paths: - Apps summary: Create a New App operationId: apps_create - security: - - bearer_auth: - - write description: >- Create a new app by submitting an app specification. For documentation on app specifications (`AppSpec` objects), please refer to [the product @@ -2278,9 +2251,6 @@ paths: - Apps summary: Delete an App operationId: apps_delete - security: - - bearer_auth: - - write description: >- Delete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up @@ -2320,9 +2290,6 @@ paths: - Apps summary: Retrieve an Existing App operationId: apps_get - security: - - bearer_auth: - - read description: >- Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. @@ -2364,9 +2331,6 @@ paths: - Apps summary: Update an App operationId: apps_update - security: - - bearer_auth: - - write description: >- Update an existing app by submitting a new app specification. For documentation on app specifications (`AppSpec` objects), please refer to @@ -2612,9 +2576,6 @@ paths: - Apps summary: Retrieve Active Deployment Logs operationId: Apps_getActiveDeploymentLogs - security: - - bearer_auth: - - read description: >- Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active @@ -2666,9 +2627,6 @@ paths: - Apps summary: List App Deployments operationId: Apps_listDeployments - security: - - bearer_auth: - - read description: List all deployments of an app. parameters: - $ref: '#/components/parameters/app_id' @@ -2707,9 +2665,6 @@ paths: - Apps summary: Create an App Deployment operationId: Apps_createDeployment - security: - - bearer_auth: - - write description: >- Creating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app. @@ -2759,9 +2714,6 @@ paths: - Apps summary: Retrieve an App Deployment operationId: Apps_getDeploymentInfo - security: - - bearer_auth: - - read description: Retrieve information about an app deployment. parameters: - $ref: '#/components/parameters/app_id' @@ -2804,9 +2756,6 @@ paths: - Apps summary: Cancel a Deployment operationId: Apps_cancelDeployment - security: - - bearer_auth: - - write description: Immediately cancel an in-progress deployment. parameters: - $ref: '#/components/parameters/app_id' @@ -2845,9 +2794,6 @@ paths: - Apps summary: Retrieve Deployment Logs operationId: Apps_getDeploymentLogs - security: - - bearer_auth: - - read description: >- Retrieve the logs of a past, in-progress, or active deployment. The response will include links to either real-time logs of an in-progress @@ -2897,9 +2843,6 @@ paths: - Apps summary: Retrieve Aggregate Deployment Logs operationId: Apps_getAggregateDeploymentLogs - security: - - bearer_auth: - - read description: >- Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that @@ -2950,9 +2893,6 @@ paths: - Apps summary: Retrieve Active Deployment Aggregate Logs operationId: Apps_getActiveDeploymentLogs - security: - - bearer_auth: - - read description: >- Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active @@ -3039,9 +2979,6 @@ paths: - Apps summary: Retrieve an App Tier operationId: Apps_getTierInfo - security: - - bearer_auth: - - read description: Retrieve information about a specific app tier. parameters: - $ref: '#/components/parameters/slug_tier' @@ -3115,9 +3052,6 @@ paths: - Apps summary: Retrieve an Instance Size operationId: Apps_getInstanceSize - security: - - bearer_auth: - - read description: >- Retrieve information about a specific instance size for `service`, `worker`, and `job` components. @@ -3242,9 +3176,6 @@ paths: - Apps summary: List all app alerts operationId: Apps_listAlerts - security: - - bearer_auth: - - read description: >- List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack @@ -3285,9 +3216,6 @@ paths: - Apps summary: Update destinations for alerts operationId: Apps_updateDestinationsForAlerts - security: - - bearer_auth: - - write description: >- Updates the emails and slack webhook destinations for app alerts. Emails must be associated to a user with access to the app. @@ -3349,9 +3277,6 @@ paths: - Apps summary: Rollback App operationId: Apps_rollbackDeployment - security: - - bearer_auth: - - write description: > Rollback an app to a previous deployment. A new deployment will be created to perform the rollback. @@ -3412,9 +3337,6 @@ paths: - Apps summary: Validate App Rollback operationId: Apps_validateRollback - security: - - bearer_auth: - - write description: > Check whether an app can be rolled back to a specific deployment. This endpoint can also be used @@ -3471,9 +3393,6 @@ paths: - Apps summary: Commit App Rollback operationId: Apps_commitRollback - security: - - bearer_auth: - - write description: > Commit an app rollback. This action permanently applies the rollback and unpins the app to resume new deployments. @@ -3513,9 +3432,6 @@ paths: - Apps summary: Revert App Rollback operationId: Apps_revertRollback - security: - - bearer_auth: - - write description: > Revert an app rollback. This action reverts the active rollback by creating a new deployment from the @@ -3558,9 +3474,6 @@ paths: - Apps summary: Retrieve App Daily Bandwidth Metrics operationId: Apps_getAppDailyBandwidthMetrics - security: - - bearer_auth: - - read description: Retrieve daily bandwidth usage metrics for a single app. parameters: - $ref: '#/components/parameters/app_id' @@ -3669,9 +3582,6 @@ paths: - CDN Endpoints summary: List All CDN Endpoints operationId: CdnEndpoints_listAll - security: - - bearer_auth: - - read description: >- To list all of the CDN endpoints available on your account, send a GET request to `/v2/cdn/endpoints`. @@ -3853,9 +3763,6 @@ paths: - CDN Endpoints summary: Retrieve an Existing CDN Endpoint operationId: CdnEndpoints_getExistingEndpoint - security: - - bearer_auth: - - read description: >- To show information about an existing CDN endpoint, send a GET request to `/v2/cdn/endpoints/$ENDPOINT_ID`. @@ -3918,9 +3825,6 @@ paths: - CDN Endpoints summary: Update a CDN Endpoint operationId: CdnEndpoints_updateEndpoint - security: - - bearer_auth: - - write description: > To update the TTL, certificate ID, or the FQDN of the custom subdomain for @@ -4008,9 +3912,6 @@ paths: - CDN Endpoints summary: Delete a CDN Endpoint operationId: CdnEndpoints_deleteEndpoint - security: - - bearer_auth: - - write description: > To delete a specific CDN endpoint, send a DELETE request to @@ -4081,9 +3982,6 @@ paths: - CDN Endpoints summary: Purge the Cache for an Existing CDN Endpoint operationId: CdnEndpoints_purgeCache - security: - - bearer_auth: - - write description: > To purge cached content from a CDN endpoint, send a DELETE request to @@ -4178,9 +4076,6 @@ paths: - Certificates summary: List All Certificates operationId: certificates_list - security: - - bearer_auth: - - read description: >- To list all of the certificates available on your account, send a GET request to `/v2/certificates`. @@ -4385,9 +4280,6 @@ paths: - Certificates summary: Retrieve an Existing Certificate operationId: certificates_get - security: - - bearer_auth: - - read description: >- To show information about an existing certificate, send a GET request to `/v2/certificates/$CERTIFICATE_ID`. @@ -4452,9 +4344,6 @@ paths: - Certificates summary: Delete a Certificate operationId: certificates_delete - security: - - bearer_auth: - - write description: | To delete a specific certificate, send a DELETE request to `/v2/certificates/$CERTIFICATE_ID`. @@ -4604,9 +4493,6 @@ paths: - Billing summary: List All Invoices operationId: invoices_list - security: - - bearer_auth: - - read description: >- To retrieve a list of all invoices, send a GET request to `/v2/customers/my/invoices`. @@ -4645,9 +4531,6 @@ paths: - Billing summary: Retrieve an Invoice by UUID operationId: Billing_getInvoiceByUuid - security: - - bearer_auth: - - read description: >- To retrieve the invoice items for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID`. @@ -4687,9 +4570,6 @@ paths: - Billing summary: Retrieve an Invoice CSV by UUID operationId: Billing_getInvoiceCsvByUuid - security: - - bearer_auth: - - read description: >- To retrieve a CSV for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/csv`. @@ -4729,9 +4609,6 @@ paths: - Billing summary: Retrieve an Invoice PDF by UUID operationId: Billing_getPdfByUuid - security: - - bearer_auth: - - read description: >- To retrieve a PDF for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/pdf`. @@ -4771,9 +4648,6 @@ paths: - Billing summary: Retrieve an Invoice Summary by UUID operationId: Billing_getInvoiceSummaryByUuid - security: - - bearer_auth: - - read description: >- To retrieve a summary for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/summary`. @@ -4872,9 +4746,6 @@ paths: - Databases summary: List All Database Clusters operationId: Databases_listClusters - security: - - bearer_auth: - - read description: >- To list all of the database clusters available on your account, send a GET request to `/v2/databases`. To limit the results to database @@ -5107,9 +4978,6 @@ paths: - Databases summary: Retrieve an Existing Database Cluster operationId: Databases_getClusterInfo - security: - - bearer_auth: - - read description: >- To show information about an existing database cluster, send a GET request to `/v2/databases/$DATABASE_ID`. @@ -5184,9 +5052,6 @@ paths: - Databases summary: Destroy a Database Cluster operationId: Databases_destroyCluster - security: - - bearer_auth: - - write description: >- To destroy a specific database, send a DELETE request to `/v2/databases/$DATABASE_ID`. @@ -5251,9 +5116,6 @@ paths: - Databases summary: Retrieve an Existing Database Cluster Configuration operationId: Databases_getClusterConfig - security: - - bearer_auth: - - read description: > Shows configuration parameters for an existing database cluster by sending a GET request to @@ -5303,9 +5165,6 @@ paths: - Databases summary: Update the Database Configuration for an Existing Database operationId: Databases_updateConfigCluster - security: - - bearer_auth: - - write description: > To update the configuration for an existing database cluster, send a PATCH request to @@ -5363,9 +5222,6 @@ paths: - Databases summary: Retrieve the Public Certificate operationId: Databases_getPublicCertificate - security: - - bearer_auth: - - read description: > To retrieve the public certificate used to secure the connection to the database cluster send a GET request to @@ -5430,9 +5286,6 @@ paths: - Databases summary: Retrieve the Status of an Online Migration operationId: Databases_getMigrationStatus - security: - - bearer_auth: - - read description: >- To retrieve the status of the most recent online migration, send a GET request to `/v2/databases/$DATABASE_ID/online-migration`. @@ -5478,9 +5331,6 @@ paths: - Databases summary: Start an Online Migration operationId: Databases_startOnlineMigration - security: - - bearer_auth: - - write description: >- To start an online migration, send a PUT request to `/v2/databases/$DATABASE_ID/online-migration` endpoint. Migrating a @@ -5565,9 +5415,6 @@ paths: - Databases summary: Stop an Online Migration operationId: Databases_stopOnlineMigration - security: - - bearer_auth: - - write description: > To stop an online migration, send a DELETE request to `/v2/databases/$DATABASE_ID/online-migration/$MIGRATION_ID`. @@ -5620,9 +5467,6 @@ paths: - Databases summary: Migrate a Database Cluster to a New Region operationId: Databases_migrateClusterToNewRegion - security: - - bearer_auth: - - write description: > To migrate a database cluster to a new region, send a `PUT` request to @@ -5716,9 +5560,6 @@ paths: - Databases summary: Resize a Database Cluster operationId: Databases_resizeCluster - security: - - bearer_auth: - - write description: >- To resize a database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/resize`. The body of the request must @@ -5811,9 +5652,6 @@ paths: - Databases summary: List Firewall Rules (Trusted Sources) for a Database Cluster operationId: Databases_listFirewallRules - security: - - bearer_auth: - - read description: >- To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to @@ -5876,9 +5714,6 @@ paths: - Databases summary: Update Firewall Rules (Trusted Sources) for a Database operationId: Databases_updateFirewallRules - security: - - bearer_auth: - - write description: >- To update a database cluster's firewall rules (known as "trusted sources" in the control panel), send a PUT request to @@ -6004,9 +5839,6 @@ paths: - Databases summary: Configure a Database Cluster's Maintenance Window operationId: Databases_configureMaintenanceWindow - security: - - bearer_auth: - - write description: >- To configure the window when automatic maintenance should be performed for a database cluster, send a PUT request to @@ -6093,9 +5925,6 @@ paths: - Databases summary: List Backups for a Database Cluster operationId: Databases_listBackups - security: - - bearer_auth: - - read description: >- To list all of the available backups of a PostgreSQL or MySQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/backups`. @@ -6162,9 +5991,6 @@ paths: - Databases summary: List All Read-only Replicas operationId: Databases_listReadOnlyReplicas - security: - - bearer_auth: - - read description: >- To list all of the read-only replicas associated with a database cluster, send a GET request to `/v2/databases/$DATABASE_ID/replicas`. @@ -6232,9 +6058,6 @@ paths: - Databases summary: Create a Read-only Replica operationId: Databases_createReadOnlyReplica - security: - - bearer_auth: - - write description: >- To create a read-only replica for a PostgreSQL or MySQL database cluster, send a POST request to `/v2/databases/$DATABASE_ID/replicas` @@ -6335,9 +6158,6 @@ paths: - Databases summary: List all Events Logs operationId: Databases_listEventsLogs - security: - - bearer_auth: - - read description: | To list all of the cluster events, send a GET request to `/v2/databases/$DATABASE_ID/events`. @@ -6388,9 +6208,6 @@ paths: - Databases summary: Retrieve an Existing Read-only Replica operationId: Databases_getExistingReadOnlyReplica - security: - - bearer_auth: - - read description: >- To show information about an existing database replica, send a GET request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`. @@ -6459,9 +6276,6 @@ paths: - Databases summary: Destroy a Read-only Replica operationId: Databases_destroyReadonlyReplica - security: - - bearer_auth: - - write description: >- To destroy a specific read-only replica, send a DELETE request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`. @@ -6531,9 +6345,6 @@ paths: - Databases summary: Promote a Read-only Replica to become a Primary Cluster operationId: Databases_promoteReadonlyReplicaToPrimary - security: - - bearer_auth: - - write description: >- To promote a specific read-only replica, send a PUT request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote`. @@ -6603,9 +6414,6 @@ paths: - Databases summary: List all Database Users operationId: Databases_listUsers - security: - - bearer_auth: - - read description: > To list all of the users for your database cluster, send a GET request to @@ -6681,9 +6489,6 @@ paths: - Databases summary: Add a Database User operationId: Databases_addUser - security: - - bearer_auth: - - write description: > To add a new database user, send a POST request to `/v2/databases/$DATABASE_ID/users` @@ -6812,9 +6617,6 @@ paths: - Databases summary: Retrieve an Existing Database User operationId: Databases_getUser - security: - - bearer_auth: - - read description: > To show information about an existing database user, send a GET request to @@ -6896,9 +6698,6 @@ paths: - Databases summary: Remove a Database User operationId: Databases_removeUser - security: - - bearer_auth: - - write description: > To remove a specific database user, send a DELETE request to @@ -6970,9 +6769,6 @@ paths: - Databases summary: Update a Database User operationId: Databases_updateSettings - security: - - bearer_auth: - - write description: > To update an existing database user, send a PUT request to `/v2/databases/$DATABASE_ID/users/$USERNAME` @@ -7076,9 +6872,6 @@ paths: - Databases summary: Reset a Database User's Password or Authentication Method operationId: Databases_resetUserAuth - security: - - bearer_auth: - - write description: > To reset the password for a database user, send a POST request to @@ -7178,9 +6971,6 @@ paths: - Databases summary: List All Databases operationId: databases_list - security: - - bearer_auth: - - read description: > To list all of the databases in a clusters, send a GET request to @@ -7247,9 +7037,6 @@ paths: - Databases summary: Add a New Database operationId: databases_add - security: - - bearer_auth: - - write description: > To add a new database to an existing cluster, send a POST request to @@ -7334,9 +7121,6 @@ paths: - Databases summary: Retrieve an Existing Database operationId: databases_get - security: - - bearer_auth: - - read description: > To show information about an existing database cluster, send a GET request to @@ -7408,9 +7192,6 @@ paths: - Databases summary: Delete a Database operationId: databases_delete - security: - - bearer_auth: - - write description: > To delete a specific database, send a DELETE request to @@ -7483,9 +7264,6 @@ paths: - Databases summary: List Connection Pools (PostgreSQL) operationId: Databases_listConnectionPools - security: - - bearer_auth: - - read description: >- To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/pools`. @@ -7549,9 +7327,6 @@ paths: - Databases summary: Add a New Connection Pool (PostgreSQL) operationId: Databases_addNewConnectionPool - security: - - bearer_auth: - - write description: > For PostgreSQL database clusters, connection pools can be used to allow a @@ -7669,9 +7444,6 @@ paths: - Databases summary: Retrieve Existing Connection Pool (PostgreSQL) operationId: Databases_getConnectionPool - security: - - bearer_auth: - - read description: >- To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to @@ -7737,9 +7509,6 @@ paths: - Databases summary: Update Connection Pools (PostgreSQL) operationId: Databases_updateConnectionPoolPostgresql - security: - - bearer_auth: - - read description: >- To update a connection pool for a PostgreSQL database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/pools/$POOL_NAME`. @@ -7832,9 +7601,6 @@ paths: - Databases summary: Delete a Connection Pool (PostgreSQL) operationId: Databases_deleteConnectionPool - security: - - bearer_auth: - - write description: > To delete a specific connection pool for a PostgreSQL database cluster, send @@ -7906,9 +7672,6 @@ paths: - Databases summary: Retrieve the Eviction Policy for a Redis Cluster operationId: Databases_getEvictionPolicy - security: - - bearer_auth: - - read description: >- To retrieve the configured eviction policy for an existing Redis cluster, send a GET request to @@ -7972,9 +7735,6 @@ paths: - Databases summary: Configure the Eviction Policy for a Redis Cluster operationId: Databases_configureEvictionPolicy - security: - - bearer_auth: - - write description: >- To configure an eviction policy for an existing Redis cluster, send a PUT request to `/v2/databases/$DATABASE_ID/eviction_policy` specifying @@ -8051,9 +7811,6 @@ paths: - Databases summary: Retrieve the SQL Modes for a MySQL Cluster operationId: Databases_getSqlMode - security: - - bearer_auth: - - read description: >- To retrieve the configured SQL modes for an existing MySQL cluster, send a GET request to `/v2/databases/$DATABASE_ID/sql_mode`. @@ -8116,9 +7873,6 @@ paths: - Databases summary: Update SQL Mode for a Cluster operationId: Databases_updateSqlMode - security: - - bearer_auth: - - write description: >- To configure the SQL modes for an existing MySQL cluster, send a PUT request to `/v2/databases/$DATABASE_ID/sql_mode` specifying the desired @@ -8202,9 +7956,6 @@ paths: - Databases summary: Upgrade Major Version for a Database operationId: Databases_upgradeMajorVersion - security: - - bearer_auth: - - write description: >- To upgrade the major version of a database, send a PUT request to `/v2/databases/$DATABASE_ID/upgrade`, specifying the target version. @@ -8266,9 +8017,6 @@ paths: - Databases summary: List Topics for a Kafka Cluster operationId: Databases_listTopicsKafkaCluster - security: - - bearer_auth: - - read description: | To list all of a Kafka cluster's topics, send a GET request to `/v2/databases/$DATABASE_ID/topics`. @@ -8318,9 +8066,6 @@ paths: - Databases summary: Create Topic for a Kafka Cluster operationId: Databases_createTopicKafkaCluster - security: - - bearer_auth: - - write description: | To create a topic attached to a Kafka cluster, send a POST request to `/v2/databases/$DATABASE_ID/topics`. @@ -8393,9 +8138,6 @@ paths: - Databases summary: Get Topic for a Kafka Cluster operationId: Databases_getTopicKafkaCluster - security: - - bearer_auth: - - read description: > To retrieve a given topic by name from the set of a Kafka cluster's topics, @@ -8451,9 +8193,6 @@ paths: - Databases summary: Update Topic for a Kafka Cluster operationId: Databases_updateTopicKafkaCluster - security: - - bearer_auth: - - write description: | To update a topic attached to a Kafka cluster, send a PUT request to `/v2/databases/$DATABASE_ID/topics/$TOPIC_NAME`. @@ -8525,9 +8264,6 @@ paths: - Databases summary: Delete Topic for a Kafka Cluster operationId: Databases_deleteTopicKafkaCluster - security: - - bearer_auth: - - write description: | To delete a single topic within a Kafka cluster, send a DELETE request to `/v2/databases/$DATABASE_ID/topics/$TOPIC_NAME`. @@ -8694,9 +8430,6 @@ paths: - Domains summary: List All Domains operationId: domains_list - security: - - bearer_auth: - - read description: >- To retrieve a list of all of the domains in your account, send a GET request to `/v2/domains`. @@ -8855,9 +8588,6 @@ paths: - Domains summary: Retrieve an Existing Domain operationId: domains_get - security: - - bearer_auth: - - read description: >- To get details about a specific domain, send a GET request to `/v2/domains/$DOMAIN_NAME`. @@ -8920,9 +8650,6 @@ paths: - Domains summary: Delete a Domain operationId: domains_delete - security: - - bearer_auth: - - write description: | To delete a domain, send a DELETE request to `/v2/domains/$DOMAIN_NAME`. parameters: @@ -8985,9 +8712,6 @@ paths: - Domain Records summary: List All Domain Records operationId: DomainRecords_listAllRecords - security: - - bearer_auth: - - read description: >+ To get a listing of all records configured for a domain, send a GET request to `/v2/domains/$DOMAIN_NAME/records`. @@ -9069,9 +8793,6 @@ paths: - Domain Records summary: Create a New Domain Record operationId: DomainRecords_createNewRecord - security: - - bearer_auth: - - write description: > To create a new record to a domain, send a POST request to @@ -9193,9 +8914,6 @@ paths: - Domain Records summary: Retrieve an Existing Domain Record operationId: DomainRecords_getExistingRecord - security: - - bearer_auth: - - read description: >- To retrieve a specific domain record, send a GET request to `/v2/domains/$DOMAIN_NAME/records/$RECORD_ID`. @@ -9263,9 +8981,6 @@ paths: - Domain Records summary: Update a Domain Record operationId: DomainRecords_updateRecordById - security: - - bearer_auth: - - write description: > To update an existing record, send a PATCH request to @@ -9335,9 +9050,6 @@ paths: - Domain Records summary: Update a Domain Record operationId: DomainRecords_updateRecordById - security: - - bearer_auth: - - write description: > To update an existing record, send a PUT request to @@ -9442,9 +9154,6 @@ paths: - Domain Records summary: Delete a Domain Record operationId: DomainRecords_deleteById - security: - - bearer_auth: - - write description: | To delete a record for a domain, send a DELETE request to `/v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID`. @@ -9521,9 +9230,6 @@ paths: - Droplets summary: List All Droplets operationId: droplets_list - security: - - bearer_auth: - - read description: > To list all Droplets in your account, send a GET request to `/v2/droplets`. @@ -9791,9 +9497,6 @@ paths: - Droplets summary: Deleting Droplets by Tag operationId: Droplets_deleteByTag - security: - - bearer_auth: - - write description: > To delete **all** Droplets assigned to a specific tag, include the `tag_name` @@ -9867,9 +9570,6 @@ paths: - Droplets summary: Retrieve an Existing Droplet operationId: droplets_get - security: - - bearer_auth: - - read description: | To show information about an individual Droplet, send a GET request to `/v2/droplets/$DROPLET_ID`. @@ -9932,9 +9632,6 @@ paths: - Droplets summary: Delete an Existing Droplet operationId: droplets_destroy - security: - - bearer_auth: - - write description: > To delete a Droplet, send a DELETE request to `/v2/droplets/$DROPLET_ID`. @@ -10004,9 +9701,6 @@ paths: - Droplets summary: List Backups for a Droplet operationId: Droplets_listBackups - security: - - bearer_auth: - - read description: > To retrieve any backups associated with a Droplet, send a GET request to @@ -10087,9 +9781,6 @@ paths: - Droplets summary: List Snapshots for a Droplet operationId: Droplets_listSnapshots - security: - - bearer_auth: - - read description: > To retrieve the snapshots that have been created from a Droplet, send a GET @@ -10172,9 +9863,6 @@ paths: - Droplet Actions summary: List Actions for a Droplet operationId: dropletActions_list - security: - - bearer_auth: - - read description: > To retrieve a list of all actions that have been executed for a Droplet, send @@ -10260,9 +9948,6 @@ paths: - Droplet Actions summary: Initiate a Droplet Action operationId: dropletActions_post - security: - - bearer_auth: - - write description: > To initiate an action on a Droplet send a POST request to @@ -10709,9 +10394,6 @@ paths: - Droplet Actions summary: Acting on Tagged Droplets operationId: DropletActions_actOnTaggedDroplets - security: - - bearer_auth: - - write description: > Some actions can be performed in bulk on tagged Droplets. The actions can be @@ -10822,9 +10504,6 @@ paths: - Droplet Actions summary: Retrieve a Droplet Action operationId: dropletActions_get - security: - - bearer_auth: - - read description: > To retrieve a Droplet action, send a GET request to @@ -10900,9 +10579,6 @@ paths: - Droplets summary: List All Available Kernels for a Droplet operationId: Droplets_listKernels - security: - - bearer_auth: - - read description: > To retrieve a list of all kernels available to a Droplet, send a GET request @@ -10985,9 +10661,6 @@ paths: - Droplets summary: List all Firewalls Applied to a Droplet operationId: Droplets_listFirewalls - security: - - bearer_auth: - - read description: > To retrieve a list of all firewalls available to a Droplet, send a GET request @@ -11025,9 +10698,6 @@ paths: - Droplets summary: List Neighbors for a Droplet operationId: Droplets_listNeighbors - security: - - bearer_auth: - - read description: > To retrieve a list of any "neighbors" (i.e. Droplets that are co-located on @@ -11084,9 +10754,6 @@ paths: - Droplets summary: List Associated Resources for a Droplet operationId: Droplets_listAssociatedResources - security: - - bearer_auth: - - read description: > To list the associated billable resources that can be destroyed along with a @@ -11139,9 +10806,6 @@ paths: - Droplets summary: Selectively Destroy a Droplet and its Associated Resources operationId: Droplets_destroyAssociatedResourcesSelective - security: - - bearer_auth: - - write description: > To destroy a Droplet along with a sub-set of its associated resources, send a @@ -11217,9 +10881,6 @@ paths: - Droplets summary: Destroy a Droplet and All of its Associated Resources (Dangerous) operationId: Droplets_deleteDangerous - security: - - bearer_auth: - - write description: > To destroy a Droplet along with all of its associated resources, send a DELETE @@ -11285,9 +10946,6 @@ paths: - Droplets summary: Check Status of a Droplet Destroy with Associated Resources Request operationId: Droplets_checkDestroyStatus - security: - - bearer_auth: - - read description: > To check on the status of a request to destroy a Droplet with its associated @@ -11336,9 +10994,6 @@ paths: - Droplets summary: Retry a Droplet Destroy with Associated Resources Request operationId: Droplets_retryDestroyWithAssociatedResources - security: - - bearer_auth: - - write description: > If the status of a request to destroy a Droplet with its associated resources @@ -11401,9 +11056,6 @@ paths: - Firewalls summary: List All Firewalls operationId: firewalls_list - security: - - bearer_auth: - - read description: >- To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`. @@ -11671,9 +11323,6 @@ paths: - Firewalls summary: Retrieve an Existing Firewall operationId: firewalls_get - security: - - bearer_auth: - - read description: >- To show information about an existing firewall, send a GET request to `/v2/firewalls/$FIREWALL_ID`. @@ -11736,9 +11385,6 @@ paths: - Firewalls summary: Update a Firewall operationId: firewalls_update - security: - - bearer_auth: - - write description: > To update the configuration of an existing firewall, send a PUT request to @@ -11957,9 +11603,6 @@ paths: - Firewalls summary: Delete a Firewall operationId: firewalls_delete - security: - - bearer_auth: - - write description: > To delete a firewall send a DELETE request to `/v2/firewalls/$FIREWALL_ID`. @@ -12031,9 +11674,6 @@ paths: - Firewalls summary: Add Droplets to a Firewall operationId: Firewalls_addDroplets - security: - - bearer_auth: - - write description: > To assign a Droplet to a firewall, send a POST request to @@ -12133,9 +11773,6 @@ paths: - Firewalls summary: Remove Droplets from a Firewall operationId: Firewalls_removeDroplets - security: - - bearer_auth: - - write description: > To remove a Droplet from a firewall, send a DELETE request to @@ -12237,9 +11874,6 @@ paths: - Firewalls summary: Add Tags to a Firewall operationId: Firewalls_addTags - security: - - bearer_auth: - - write description: > To assign a tag representing a group of Droplets to a firewall, send a POST @@ -12336,9 +11970,6 @@ paths: - Firewalls summary: Remove Tags from a Firewall operationId: Firewalls_removeTags - security: - - bearer_auth: - - write description: > To remove a tag representing a group of Droplets from a firewall, send a @@ -12435,9 +12066,6 @@ paths: - Firewalls summary: Add Rules to a Firewall operationId: Firewalls_addRules - security: - - bearer_auth: - - write description: > To add additional access rules to a firewall, send a POST request to @@ -12609,9 +12237,6 @@ paths: - Firewalls summary: Remove Rules from a Firewall operationId: Firewalls_removeRules - security: - - bearer_auth: - - write description: > To remove access rules from a firewall, send a DELETE request to @@ -12786,9 +12411,6 @@ paths: - Floating IPs summary: List All Floating IPs operationId: floatingIPs_list - security: - - bearer_auth: - - read description: >- To list all of the floating IPs available on your account, send a GET request to `/v2/floating_ips`. @@ -12923,9 +12545,6 @@ paths: - Floating IPs summary: Retrieve an Existing Floating IP operationId: floatingIPs_get - security: - - bearer_auth: - - read description: >- To show information about a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP_ADDR`. @@ -12980,9 +12599,6 @@ paths: - Floating IPs summary: Delete a Floating IP operationId: floatingIPs_delete - security: - - bearer_auth: - - write description: > To delete a floating IP and remove it from your account, send a DELETE request @@ -13046,9 +12662,6 @@ paths: - Floating IP Actions summary: List All Actions for a Floating IP operationId: floatingIPsAction_list - security: - - bearer_auth: - - read description: >- To retrieve all actions that have been executed on a floating IP, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions`. @@ -13109,9 +12722,6 @@ paths: - Floating IP Actions summary: Initiate a Floating IP Action operationId: floatingIPsAction_post - security: - - bearer_auth: - - write description: > To initiate an action on a floating IP send a POST request to @@ -13214,9 +12824,6 @@ paths: - Floating IP Actions summary: Retrieve an Existing Floating IP Action operationId: floatingIPsAction_get - security: - - bearer_auth: - - read description: >- To retrieve the status of a floating IP action, send a GET request to `/v2/floating_ips/$FLOATING_IP/actions/$ACTION_ID`. @@ -13366,9 +12973,6 @@ paths: - Functions summary: Get Namespace operationId: Functions_getNamespaceDetails - security: - - bearer_auth: - - read description: >- Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to @@ -13409,9 +13013,6 @@ paths: - Functions summary: Delete Namespace operationId: Functions_deleteNamespace - security: - - bearer_auth: - - write description: >- Deletes the given namespace. When a namespace is deleted all assets, in the namespace are deleted, this includes packages, functions and @@ -13458,9 +13059,6 @@ paths: - Functions summary: List Triggers operationId: Functions_listTriggers - security: - - bearer_auth: - - read description: >- Returns a list of triggers associated with the current user and namespace. To get all triggers, send a GET request to @@ -13499,9 +13097,6 @@ paths: - Functions summary: Create Trigger operationId: Functions_createTriggerInNamespace - security: - - bearer_auth: - - write description: >- Creates a new trigger for a given function in a namespace. To create a trigger, send a POST request to @@ -13573,9 +13168,6 @@ paths: - Functions summary: Get Trigger operationId: Functions_getTriggerDetails - security: - - bearer_auth: - - read description: >- Gets the trigger details. To get the trigger details, send a GET request to `/v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME`. @@ -13618,9 +13210,6 @@ paths: - Functions summary: Update Trigger operationId: Functions_updateTriggerDetails - security: - - bearer_auth: - - write description: >- Updates the details of the given trigger. To update a trigger, send a PUT request to @@ -13686,9 +13275,6 @@ paths: - Functions summary: Delete Trigger operationId: Functions_deleteTrigger - security: - - bearer_auth: - - read description: >- Deletes the given trigger. @@ -13736,9 +13322,6 @@ paths: - Images summary: List All Images operationId: images_list - security: - - bearer_auth: - - read description: > To list all of the images available on your account, send a GET request to /v2/images. @@ -13933,9 +13516,6 @@ paths: - Images summary: Retrieve an Existing Image operationId: images_get - security: - - bearer_auth: - - read description: | To retrieve information about an image, send a `GET` request to `/v2/images/$IDENTIFIER`. @@ -14037,9 +13617,6 @@ paths: - Images summary: Update an Image operationId: images_update - security: - - bearer_auth: - - write description: > To update an image, send a `PUT` request to `/v2/images/$IMAGE_ID`. @@ -14124,9 +13701,6 @@ paths: - Images summary: Delete an Image operationId: images_delete - security: - - bearer_auth: - - write description: > To delete a snapshot or custom image, send a `DELETE` request to `/v2/images/$IMAGE_ID`. @@ -14190,9 +13764,6 @@ paths: - Image Actions summary: List All Actions for an Image operationId: imageActions_list - security: - - bearer_auth: - - read description: >- To retrieve all actions that have been executed on an image, send a GET request to `/v2/images/$IMAGE_ID/actions`. @@ -14248,9 +13819,6 @@ paths: - Image Actions summary: Initiate an Image Action operationId: imageActions_post - security: - - bearer_auth: - - write description: > The following actions are available on an Image. @@ -14368,9 +13936,6 @@ paths: - Image Actions summary: Retrieve an Existing Action operationId: imageActions_get - security: - - bearer_auth: - - read description: >- To retrieve the status of an image action, send a GET request to `/v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_ID`. @@ -14435,9 +14000,6 @@ paths: - Kubernetes summary: List All Kubernetes Clusters operationId: Kubernetes_listClusters - security: - - bearer_auth: - - read description: > To list all of the Kubernetes clusters on your account, send a GET request @@ -14654,9 +14216,6 @@ paths: - Kubernetes summary: Retrieve an Existing Kubernetes Cluster operationId: Kubernetes_getClusterInfo - security: - - bearer_auth: - - read description: > To show information about an existing Kubernetes cluster, send a GET request @@ -14725,9 +14284,6 @@ paths: - Kubernetes summary: Update a Kubernetes Cluster operationId: Kubernetes_updateCluster - security: - - bearer_auth: - - write description: | To update a Kubernetes cluster, send a PUT request to `/v2/kubernetes/clusters/$K8S_CLUSTER_ID` and specify one or more of the @@ -14835,9 +14391,6 @@ paths: - Kubernetes summary: Delete a Kubernetes Cluster operationId: Kubernetes_deleteCluster - security: - - bearer_auth: - - write description: > To delete a Kubernetes cluster and all services deployed to it, send a DELETE @@ -14913,9 +14466,6 @@ paths: - Kubernetes summary: List Associated Resources for Cluster Deletion operationId: Kubernetes_listAssociatedResources - security: - - bearer_auth: - - read description: >- To list the associated billable resources that can be destroyed along with a cluster, send a GET request to the @@ -14979,9 +14529,6 @@ paths: - Kubernetes summary: Selectively Delete a Cluster and its Associated Resources operationId: Kubernetes_selectiveClusterDestroy - security: - - bearer_auth: - - write description: > To delete a Kubernetes cluster along with a subset of its associated resources, @@ -15083,9 +14630,6 @@ paths: - Kubernetes summary: Delete a Cluster and All of its Associated Resources (Dangerous) operationId: Kubernetes_deleteClusterAssociatedResourcesDangerous - security: - - bearer_auth: - - write description: > To delete a Kubernetes cluster with all of its associated resources, send a @@ -15152,9 +14696,6 @@ paths: - Kubernetes summary: Retrieve the kubeconfig for a Kubernetes Cluster operationId: Kubernetes_getKubeconfig - security: - - bearer_auth: - - write description: > This endpoint returns a kubeconfig file in YAML format. It can be used to @@ -15263,9 +14804,6 @@ paths: - Kubernetes summary: Retrieve Credentials for a Kubernetes Cluster operationId: Kubernetes_getCredentialsByClusterId - security: - - bearer_auth: - - write description: > This endpoint returns a JSON object . It can be used to programmatically @@ -15366,9 +14904,6 @@ paths: - Kubernetes summary: Retrieve Available Upgrades for an Existing Kubernetes Cluster operationId: Kubernetes_getAvailableUpgrades - security: - - bearer_auth: - - read description: > To determine whether a cluster can be upgraded, and the versions to which it @@ -15433,9 +14968,6 @@ paths: - Kubernetes summary: Upgrade a Kubernetes Cluster operationId: Kubernetes_upgradeCluster - security: - - bearer_auth: - - write description: > To immediately upgrade a Kubernetes cluster to a newer patch release of @@ -15501,9 +15033,6 @@ paths: - Kubernetes summary: List All Node Pools in a Kubernetes Clusters operationId: Kubernetes_listNodePools - security: - - bearer_auth: - - read description: > To list all of the node pools in a Kubernetes clusters, send a GET request to @@ -15579,9 +15108,6 @@ paths: - Kubernetes summary: Add a Node Pool to a Kubernetes Cluster operationId: Kubernetes_addNodePool - security: - - bearer_auth: - - write description: > To add an additional node pool to a Kubernetes clusters, send a POST request @@ -15704,9 +15230,6 @@ paths: - Kubernetes summary: Retrieve a Node Pool for a Kubernetes Cluster operationId: Kubernetes_getNodePool - security: - - bearer_auth: - - read description: > To show information about a specific node pool in a Kubernetes cluster, send @@ -15782,9 +15305,6 @@ paths: - Kubernetes summary: Update a Node Pool in a Kubernetes Cluster operationId: Kubernetes_updateNodePool - security: - - bearer_auth: - - write description: > To update the name of a node pool, edit the tags applied to it, or adjust its @@ -15910,9 +15430,6 @@ paths: - Kubernetes summary: Delete a Node Pool in a Kubernetes Cluster operationId: Kubernetes_deleteNodePool - security: - - bearer_auth: - - write description: > To delete a node pool, send a DELETE request to @@ -15993,9 +15510,6 @@ paths: - Kubernetes summary: Delete a Node in a Kubernetes Cluster operationId: Kubernetes_deleteNodeInNodePool - security: - - bearer_auth: - - write description: > To delete a single node in a pool, send a DELETE request to @@ -16081,9 +15595,6 @@ paths: - Kubernetes summary: Recycle a Kubernetes Node Pool operationId: Kubernetes_recycleNodePool - security: - - bearer_auth: - - write description: > The endpoint has been deprecated. Please use the DELETE @@ -16119,9 +15630,6 @@ paths: - Kubernetes summary: Retrieve User Information for a Kubernetes Cluster operationId: Kubernetes_getUserInformation - security: - - bearer_auth: - - read description: > To show information the user associated with a Kubernetes cluster, send a GET @@ -16228,9 +15736,6 @@ paths: - Kubernetes summary: Run Clusterlint Checks on a Kubernetes Cluster operationId: Kubernetes_runClusterlintChecks - security: - - bearer_auth: - - read description: > Clusterlint helps operators conform to Kubernetes best practices around @@ -16317,9 +15822,6 @@ paths: - Kubernetes summary: Fetch Clusterlint Diagnostics for a Kubernetes Cluster operationId: Kubernetes_getClusterLintDiagnostics - security: - - bearer_auth: - - read description: > To request clusterlint diagnostics for your cluster, send a GET request to @@ -16737,9 +16239,6 @@ paths: - Load Balancers summary: List All Load Balancers operationId: loadBalancers_list - security: - - bearer_auth: - - read description: > To list all of the load balancer instances on your account, send a GET request @@ -16810,9 +16309,6 @@ paths: - Load Balancers summary: Retrieve an Existing Load Balancer operationId: loadBalancers_get - security: - - bearer_auth: - - read description: > To show information about a load balancer instance, send a GET request to @@ -16880,10 +16376,7 @@ paths: tags: - Load Balancers summary: Update a Load Balancer - operationId: loadBalancers_update - security: - - bearer_auth: - - write + operationId: loadBalancers_update description: > To update a load balancer's settings, send a PUT request to @@ -17111,9 +16604,6 @@ paths: - Load Balancers summary: Delete a Load Balancer operationId: loadBalancers_delete - security: - - bearer_auth: - - write description: > To delete a load balancer instance, disassociating any Droplets assigned to it @@ -17191,9 +16681,6 @@ paths: - Load Balancers summary: Add Droplets to a Load Balancer operationId: LoadBalancers_assignDroplets - security: - - bearer_auth: - - write description: > To assign a Droplet to a load balancer instance, send a POST request to @@ -17296,9 +16783,6 @@ paths: - Load Balancers summary: Remove Droplets from a Load Balancer operationId: LoadBalancers_removeDroplets - security: - - bearer_auth: - - write description: > To remove a Droplet from a load balancer instance, send a DELETE request to @@ -17400,9 +16884,6 @@ paths: - Load Balancers summary: Add Forwarding Rules to a Load Balancer operationId: LoadBalancers_addForwardingRules - security: - - bearer_auth: - - write description: > To add an additional forwarding rule to a load balancer instance, send a POST @@ -17526,9 +17007,6 @@ paths: - Load Balancers summary: Remove Forwarding Rules from a Load Balancer operationId: LoadBalancers_removeForwardingRules - security: - - bearer_auth: - - write description: > To remove forwarding rules from a load balancer instance, send a DELETE @@ -17655,9 +17133,6 @@ paths: - Monitoring summary: List Alert Policies operationId: Monitoring_listAlertPolicies - security: - - bearer_auth: - - read description: >- Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to `/v2/monitoring/alerts`. @@ -17866,9 +17341,6 @@ paths: - Monitoring summary: Retrieve an Existing Alert Policy operationId: Monitoring_getExistingAlertPolicy - security: - - bearer_auth: - - read description: >- To retrieve a given alert policy, send a GET request to `/v2/monitoring/alerts/{alert_uuid}` @@ -17907,9 +17379,6 @@ paths: - Monitoring summary: Update an Alert Policy operationId: Monitoring_updateAlertPolicy - security: - - bearer_auth: - - write description: >- To update en existing policy, send a PUT request to `v2/monitoring/alerts/{alert_uuid}`. @@ -18087,9 +17556,6 @@ paths: - Monitoring summary: Delete an Alert Policy operationId: Monitoring_deleteAlertPolicy - security: - - bearer_auth: - - write description: >- To delete an alert policy, send a DELETE request to `/v2/monitoring/alerts/{alert_uuid}` @@ -18129,9 +17595,6 @@ paths: - Monitoring summary: Get Droplet Bandwidth Metrics operationId: Monitoring_getDropletBandwidthMetrics - security: - - bearer_auth: - - read description: >- To retrieve bandwidth metrics for a given Droplet, send a GET request to `/v2/monitoring/metrics/droplet/bandwidth`. Use the `interface` query @@ -18184,9 +17647,6 @@ paths: - Monitoring summary: Get Droplet CPU Metrics operationId: Monitoring_dropletCpuMetricsget - security: - - bearer_auth: - - read description: >- To retrieve CPU metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/cpu`. @@ -18230,9 +17690,6 @@ paths: - Monitoring summary: Get Droplet Filesystem Free Metrics operationId: Monitoring_getDropletFilesystemFreeMetrics - security: - - bearer_auth: - - read description: >- To retrieve filesystem free metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/filesystem_free`. @@ -18277,9 +17734,6 @@ paths: - Monitoring summary: Get Droplet Filesystem Size Metrics operationId: Monitoring_getDropletFilesystemSizeMetrics - security: - - bearer_auth: - - read description: >- To retrieve filesystem size metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/filesystem_size`. @@ -18324,9 +17778,6 @@ paths: - Monitoring summary: Get Droplet Load1 Metrics operationId: Monitoring_getDropletLoad1Metrics - security: - - bearer_auth: - - read description: >- To retrieve 1 minute load average metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/load_1`. @@ -18371,9 +17822,6 @@ paths: - Monitoring summary: Get Droplet Load5 Metrics operationId: Monitoring_dropletLoad5MetricsGet - security: - - bearer_auth: - - read description: >- To retrieve 5 minute load average metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/load_5`. @@ -18418,9 +17866,6 @@ paths: - Monitoring summary: Get Droplet Load15 Metrics operationId: Monitoring_getDropletLoad15Metrics - security: - - bearer_auth: - - read description: >- To retrieve 15 minute load average metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/load_15`. @@ -18465,9 +17910,6 @@ paths: - Monitoring summary: Get Droplet Cached Memory Metrics operationId: Monitoring_dropletMemoryCachedMetrics - security: - - bearer_auth: - - read description: >- To retrieve cached memory metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/memory_cached`. @@ -18512,9 +17954,6 @@ paths: - Monitoring summary: Get Droplet Free Memory Metrics operationId: Monitoring_getDropletMemoryFreeMetrics - security: - - bearer_auth: - - read description: >- To retrieve free memory metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/memory_free`. @@ -18559,9 +17998,6 @@ paths: - Monitoring summary: Get Droplet Total Memory Metrics operationId: Monitoring_getDropletMemoryTotalMetrics - security: - - bearer_auth: - - read description: >- To retrieve total memory metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/memory_total`. @@ -18606,9 +18042,6 @@ paths: - Monitoring summary: Get Droplet Available Memory Metrics operationId: Monitoring_getDropletMemoryAvailableMetrics - security: - - bearer_auth: - - read description: >- To retrieve available memory metrics for a given droplet, send a GET request to `/v2/monitoring/metrics/droplet/memory_available`. @@ -18653,9 +18086,6 @@ paths: - Monitoring summary: Get App Memory Percentage Metrics operationId: Monitoring_getAppMemoryPercentageMetrics - security: - - bearer_auth: - - read description: >- To retrieve memory percentage metrics for a given app, send a GET request to `/v2/monitoring/metrics/apps/memory_percentage`. @@ -18688,9 +18118,6 @@ paths: - Monitoring summary: Get App CPU Percentage Metrics operationId: Monitoring_getAppCpuPercentageMetrics - security: - - bearer_auth: - - read description: >- To retrieve cpu percentage metrics for a given app, send a GET request to `/v2/monitoring/metrics/apps/cpu_percentage`. @@ -18723,9 +18150,6 @@ paths: - Monitoring summary: Get App Restart Count Metrics operationId: Monitoring_getAppRestartCountMetrics - security: - - bearer_auth: - - read description: >- To retrieve restart count metrics for a given app, send a GET request to `/v2/monitoring/metrics/apps/restart_count`. @@ -18758,9 +18182,6 @@ paths: - Projects summary: List All Projects operationId: projects_list - security: - - bearer_auth: - - read description: To list all your projects, send a GET request to `/v2/projects`. parameters: - $ref: '#/components/parameters/per_page' @@ -19148,9 +18569,6 @@ paths: - Projects summary: Retrieve an Existing Project operationId: projects_get - security: - - bearer_auth: - - read description: To get a project, send a GET request to `/v2/projects/$PROJECT_ID`. parameters: - $ref: '#/components/parameters/project_id' @@ -19215,9 +18633,6 @@ paths: - Projects summary: Update a Project operationId: projects_update - security: - - bearer_auth: - - write description: >- To update a project, send a PUT request to `/v2/projects/$PROJECT_ID`. All of the following attributes must be sent. @@ -19314,9 +18729,6 @@ paths: - Projects summary: Patch a Project operationId: projects_patch - security: - - bearer_auth: - - write description: >- To update only specific attributes of a project, send a PATCH request to `/v2/projects/$PROJECT_ID`. At least one of the following attributes @@ -19407,9 +18819,6 @@ paths: - Projects summary: Delete an Existing Project operationId: projects_delete - security: - - bearer_auth: - - write description: > To delete a project, send a DELETE request to `/v2/projects/$PROJECT_ID`. To @@ -19486,9 +18895,6 @@ paths: - Project Resources summary: List Project Resources operationId: ProjectResources_list - security: - - bearer_auth: - - read description: >- To list all your resources in a project, send a GET request to `/v2/projects/$PROJECT_ID/resources`. @@ -19562,9 +18968,6 @@ paths: - Project Resources summary: Assign Resources to a Project operationId: ProjectResources_assignToProject - security: - - bearer_auth: - - write description: >- To assign resources to a project, send a POST request to `/v2/projects/$PROJECT_ID/resources`. @@ -19824,9 +19227,6 @@ paths: - Regions summary: List All Data Center Regions operationId: regions_list - security: - - bearer_auth: - - read description: >- To list all of the regions that are available, send a GET request to `/v2/regions`. @@ -20123,9 +19523,6 @@ paths: - Container Registry summary: Get Docker Credentials for Container Registry operationId: ContainerRegistry_getDockerCredentials - security: - - bearer_auth: - - read description: > In order to access your container registry with the Docker client or from a @@ -20269,9 +19666,6 @@ paths: - Container Registry summary: List All Container Registry Repositories operationId: ContainerRegistry_listRepositories - security: - - bearer_auth: - - read description: > This endpoint has been deprecated in favor of the _List All Container Registry Repositories [V2]_ endpoint. @@ -20319,9 +19713,6 @@ paths: - Container Registry summary: List All Container Registry Repositories (V2) operationId: ContainerRegistry_listRepositoriesV2 - security: - - bearer_auth: - - read description: >- To list all repositories in your container registry, send a GET request to `/v2/registry/$REGISTRY_NAME/repositoriesV2`. @@ -20372,9 +19763,6 @@ paths: - Container Registry summary: List All Container Registry Repository Tags operationId: ContainerRegistry_listRepositoryTags - security: - - bearer_auth: - - read description: > To list all tags in your container registry repository, send a GET @@ -20432,9 +19820,6 @@ paths: - Container Registry summary: Delete Container Registry Repository Tag operationId: ContainerRegistry_deleteRepositoryTag - security: - - bearer_auth: - - write description: > To delete a container repository tag, send a DELETE request to @@ -20497,9 +19882,6 @@ paths: - Container Registry summary: List All Container Registry Repository Manifests operationId: ContainerRegistry_listRepositoryManifests - security: - - bearer_auth: - - read description: > To list all manifests in your container registry repository, send a GET @@ -20558,9 +19940,6 @@ paths: - Container Registry summary: Delete Container Registry Repository Manifest operationId: ContainerRegistry_deleteRepositoryManifestByDigest - security: - - bearer_auth: - - write description: > To delete a container repository manifest by digest, send a DELETE request to @@ -20625,9 +20004,6 @@ paths: - Container Registry summary: Start Garbage Collection operationId: ContainerRegistry_startGarbageCollection - security: - - bearer_auth: - - write description: > Garbage collection enables users to clear out unreferenced blobs (layer & @@ -20708,9 +20084,6 @@ paths: - Container Registry summary: Get Active Garbage Collection operationId: ContainerRegistry_getActiveGarbageCollection - security: - - bearer_auth: - - write description: >- To get information about the currently-active garbage collection for a registry, send a GET request to @@ -20755,9 +20128,6 @@ paths: - Container Registry summary: List Garbage Collections operationId: ContainerRegistry_listGarbageCollections - security: - - bearer_auth: - - write description: >- To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. @@ -20803,9 +20173,6 @@ paths: - Container Registry summary: Update Garbage Collection operationId: ContainerRegistry_cancelGarbageCollection - security: - - bearer_auth: - - write description: >- To cancel the currently-active garbage collection for a registry, send a PUT request to `/v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID` @@ -20960,9 +20327,6 @@ paths: - Reserved IPs summary: List All Reserved IPs operationId: reservedIPs_list - security: - - bearer_auth: - - read description: >- To list all of the reserved IPs available on your account, send a GET request to `/v2/reserved_ips`. @@ -21117,9 +20481,6 @@ paths: - Reserved IPs summary: Retrieve an Existing Reserved IP operationId: reservedIPs_get - security: - - bearer_auth: - - read description: >- To show information about a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP_ADDR`. @@ -21182,9 +20543,6 @@ paths: - Reserved IPs summary: Delete a Reserved IP operationId: reservedIPs_delete - security: - - bearer_auth: - - write description: > To delete a reserved IP and remove it from your account, send a DELETE request @@ -21256,9 +20614,6 @@ paths: - Reserved IP Actions summary: List All Actions for a Reserved IP operationId: reservedIPsActions_list - security: - - bearer_auth: - - read description: >- To retrieve all actions that have been executed on a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions`. @@ -21327,9 +20682,6 @@ paths: - Reserved IP Actions summary: Initiate a Reserved IP Action operationId: reservedIPsActions_post - security: - - bearer_auth: - - write description: > To initiate an action on a reserved IP send a POST request to @@ -21449,9 +20801,6 @@ paths: - Reserved IP Actions summary: Retrieve an Existing Reserved IP Action operationId: reservedIPsActions_get - security: - - bearer_auth: - - read description: >- To retrieve the status of a reserved IP action, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID`. @@ -21516,9 +20865,6 @@ paths: - Sizes summary: List All Droplet Sizes operationId: sizes_list - security: - - bearer_auth: - - read description: >- To list all of available Droplet sizes, send a GET request to `/v2/sizes`. @@ -21591,9 +20937,6 @@ paths: - Snapshots summary: List All Snapshots operationId: snapshots_list - security: - - bearer_auth: - - read description: > To list all of the snapshots available on your account, send a GET request to @@ -21728,9 +21071,6 @@ paths: - Snapshots summary: Retrieve an Existing Snapshot operationId: snapshots_get - security: - - bearer_auth: - - read description: > To retrieve information about a snapshot, send a GET request to @@ -21807,9 +21147,6 @@ paths: - Snapshots summary: Delete a Snapshot operationId: snapshots_delete - security: - - bearer_auth: - - write description: > Both Droplet and volume snapshots are managed through the `/v2/snapshots/` @@ -21885,9 +21222,6 @@ paths: - Tags summary: List All Tags operationId: tags_list - security: - - bearer_auth: - - read description: To list all of your tags, you can send a GET request to `/v2/tags`. parameters: - $ref: '#/components/parameters/per_page' @@ -22051,9 +21385,6 @@ paths: - Tags summary: Retrieve a Tag operationId: tags_get - security: - - bearer_auth: - - read description: >- To retrieve an individual tag, you can send a `GET` request to `/v2/tags/$TAG_NAME`. @@ -22116,9 +21447,6 @@ paths: - Tags summary: Delete a Tag operationId: tags_delete - security: - - bearer_auth: - - write description: >- A tag can be deleted by sending a `DELETE` request to `/v2/tags/$TAG_NAME`. Deleting a tag also untags all the resources that @@ -22183,9 +21511,6 @@ paths: - Tags summary: Tag a Resource operationId: Tags_tagResource - security: - - bearer_auth: - - write description: >- Resources can be tagged by sending a POST request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing @@ -22288,9 +21613,6 @@ paths: - Tags summary: Untag a Resource operationId: Tags_untagResource - security: - - bearer_auth: - - write description: >- Resources can be untagged by sending a DELETE request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing @@ -22393,9 +21715,6 @@ paths: - Block Storage summary: List All Block Storage Volumes operationId: volumes_list - security: - - bearer_auth: - - read description: >+ To list all of the block storage volumes available on your account, send a GET request to `/v2/volumes`. @@ -22622,9 +21941,6 @@ paths: - Block Storage summary: Delete a Block Storage Volume by Name operationId: BlockStorage_deleteByRegionAndName - security: - - bearer_auth: - - write description: >+ Block storage volumes may also be deleted by name by sending a DELETE request with the volume's **name** and the **region slug** for the @@ -22672,9 +21988,6 @@ paths: - Block Storage Actions summary: Initiate A Block Storage Action By Volume Name operationId: volumeActions_post - security: - - bearer_auth: - - write description: > To initiate an action on a block storage volume by Name, send a POST request to @@ -22821,9 +22134,6 @@ paths: - Block Storage summary: Retrieve an Existing Volume Snapshot operationId: BlockStorage_getSnapshotDetails - security: - - bearer_auth: - - read description: >+ To retrieve the details of a snapshot that has been created from a volume, send a GET request to @@ -22868,9 +22178,6 @@ paths: - Block Storage summary: Delete a Volume Snapshot operationId: BlockStorage_deleteVolumeSnapshot - security: - - bearer_auth: - - write description: > To delete a volume snapshot, send a DELETE request to @@ -22945,9 +22252,6 @@ paths: - Block Storage summary: Retrieve an Existing Block Storage Volume operationId: volumes_get - security: - - bearer_auth: - - read description: >+ To show information about a block storage volume, send a GET request to `/v2/volumes/$VOLUME_ID`. @@ -23018,9 +22322,6 @@ paths: - Block Storage summary: Delete a Block Storage Volume operationId: volumes_delete - security: - - bearer_auth: - - write description: >+ To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to `/v2/volumes/$VOLUME_ID`. @@ -23089,9 +22390,6 @@ paths: - Block Storage Actions summary: List All Actions for a Volume operationId: volumeActions_list - security: - - bearer_auth: - - read description: >+ To retrieve all actions that have been executed on a volume, send a GET request to `/v2/volumes/$VOLUME_ID/actions`. @@ -23168,9 +22466,6 @@ paths: - Block Storage Actions summary: Initiate A Block Storage Action By Volume Id operationId: BlockStorageActions_initiateAttachAction - security: - - bearer_auth: - - write description: > To initiate an action on a block storage volume by Id, send a POST request to @@ -23396,9 +22691,6 @@ paths: - Block Storage Actions summary: Retrieve an Existing Volume Action operationId: volumeActions_get - security: - - bearer_auth: - - read description: >+ To retrieve the status of a volume action, send a GET request to `/v2/volumes/$VOLUME_ID/actions/$ACTION_ID`. @@ -23470,9 +22762,6 @@ paths: - Block Storage summary: List Snapshots for a Volume operationId: volumeSnapshots_list - security: - - bearer_auth: - - read description: >+ To retrieve the snapshots that have been created from a volume, send a GET request to `/v2/volumes/$VOLUME_ID/snapshots`. @@ -23553,9 +22842,6 @@ paths: - Block Storage summary: Create Snapshot from a Volume operationId: volumeSnapshots_create - security: - - bearer_auth: - - write description: >- To create a snapshot from a volume, sent a POST request to `/v2/volumes/$VOLUME_ID/snapshots`. @@ -23644,9 +22930,6 @@ paths: - VPCs summary: List All VPCs operationId: vpcs_list - security: - - bearer_auth: - - read description: >- To list all of the VPCs on your account, send a GET request to `/v2/vpcs`. @@ -23794,9 +23077,6 @@ paths: - VPCs summary: Retrieve an Existing VPC operationId: vpcs_get - security: - - bearer_auth: - - read description: >- To show information about an existing VPC, send a GET request to `/v2/vpcs/$VPC_ID`. @@ -23852,9 +23132,6 @@ paths: - VPCs summary: Update a VPC operationId: vpcs_update - security: - - bearer_auth: - - write description: > To update information about a VPC, send a PUT request to `/v2/vpcs/$VPC_ID`. @@ -23928,9 +23205,6 @@ paths: - VPCs summary: Partially Update a VPC operationId: vpcs_patch - security: - - bearer_auth: - - write description: | To update a subset of information about a VPC, send a PATCH request to `/v2/vpcs/$VPC_ID`. @@ -24000,9 +23274,6 @@ paths: - VPCs summary: Delete a VPC operationId: vpcs_delete - security: - - bearer_auth: - - write description: > To delete a VPC, send a DELETE request to `/v2/vpcs/$VPC_ID`. A 204 status @@ -24072,9 +23343,6 @@ paths: - VPCs summary: List the Member Resources of a VPC operationId: VpCs_listMembers - security: - - bearer_auth: - - read description: > To list all of the resources that are members of a VPC, send a GET request to @@ -24128,9 +23396,6 @@ paths: - Uptime summary: List All Checks operationId: Uptime_listChecks - security: - - bearer_auth: - - read description: >- To list all of the Uptime checks on your account, send a GET request to `/v2/uptime/checks`. @@ -24228,9 +23493,6 @@ paths: - Uptime summary: Retrieve an Existing Check operationId: Uptime_getCheckById - security: - - bearer_auth: - - read description: >- To show information about an existing check, send a GET request to `/v2/uptime/checks/$CHECK_ID`. @@ -24269,9 +23531,6 @@ paths: - Uptime summary: Update a Check operationId: Uptime_updateCheckSettings - security: - - bearer_auth: - - write description: > To update the settings of an Uptime check, send a PUT request to `/v2/uptime/checks/$CHECK_ID`. @@ -24328,9 +23587,6 @@ paths: - Uptime summary: Delete a Check operationId: Uptime_deleteCheck - security: - - bearer_auth: - - write description: > To delete an Uptime check, send a DELETE request to `/v2/uptime/checks/$CHECK_ID`. A 204 status @@ -24376,9 +23632,6 @@ paths: - Uptime summary: Retrieve Check State operationId: Uptime_getCheckState - security: - - bearer_auth: - - read description: >- To show information about an existing check's state, send a GET request to `/v2/uptime/checks/$CHECK_ID/state`. @@ -24418,9 +23671,6 @@ paths: - Uptime summary: List All Alerts operationId: Uptime_listAllAlerts - security: - - bearer_auth: - - read description: >- To list all of the alerts for an Uptime check, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts`. @@ -24461,9 +23711,6 @@ paths: - Uptime summary: Create a New Alert operationId: Uptime_createNewAlert - security: - - bearer_auth: - - write description: > To create an Uptime alert, send a POST request to `/v2/uptime/checks/$CHECK_ID/alerts` specifying the attributes @@ -24549,9 +23796,6 @@ paths: - Uptime summary: Retrieve an Existing Alert operationId: Uptime_getExistingAlert - security: - - bearer_auth: - - read description: >- To show information about an existing alert, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. @@ -24595,9 +23839,6 @@ paths: - Uptime summary: Update an Alert operationId: Uptime_updateAlertSettings - security: - - bearer_auth: - - write description: > To update the settings of an Uptime alert, send a PUT request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. @@ -24668,9 +23909,6 @@ paths: - Uptime summary: Delete an Alert operationId: Uptime_deleteAlert - security: - - bearer_auth: - - write description: > To delete an Uptime alert, send a DELETE request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. A 204 status diff --git a/sdks/db/fixed-specs/get-response-fixed-spec.yaml b/sdks/db/fixed-specs/get-response-fixed-spec.yaml new file mode 100644 index 0000000000..7e47fa0297 --- /dev/null +++ b/sdks/db/fixed-specs/get-response-fixed-spec.yaml @@ -0,0 +1,32713 @@ +openapi: 3.0.0 +info: + title: GetResponse APIv3 + description: > + + + # Limits and throttling + + + GetResponse API calls are subject to throttling to ensure a high level of + service for all users. + + + ## Time frame + + + Time frame is a period of time for which we calculate the API call limits. + The limits reset in every time frame. + + + The time frame duration is **10 minutes**. + + + ## Basic rate limits + + + Each user is allowed to make **30,000 API calls per time frame** (10 + minutes) and **80 API calls per second**. + + + ## Parallel requests limit + + + It is possible to send up to **10 simultaneous requests**. + + + ## Headers + + + Every API response includes a few additional headers: + + + * `X-RateLimit-Limit` – the total number of requests available per time + frame + + * `X-RateLimit-Remaining` – the number of requests left in the current + time frame + + * `X-RateLimit-Reset` – seconds left in the current time frame + + + ## Errors + + + The **429 Too Many Requests** HTTP response code indicates that the limit + has been reached. The error response includes `currentLimit` and + `timeToReset` fields in the context section, with the total number of + requests available per time frame and seconds left in the current time frame + respectively. + + + ## Reaching the limit + + + When you reach the limit, you need to wait for the time specified in + `timeToReset` field or `X-RateLimit-Reset` header before making another + request. + + + # Authentication + + + API can be accessed by authenticated users only. This means that every + request must be signed with your credentials. We offer two methods of + authentication: API Key and OAuth 2.0. API key is our primary method and + should be used in most cases. GetResponse MAX clients have to send an + `X-Domain` header in addition to the API key. Supported OAuth 2.0 flows are: + Authorization Code, Client Credentials, Implicit, and Refresh Token. + + + ## API key + + + Follow these steps to send an authentication request: + + + * Find your unique and secret API key in the panel: + [https://app.getresponse.com/api](https://app.getresponse.com/api) + + * Add a custom `X-Auth-Token` header to all your requests. For example, if + your API key is `jfgs8jh4ksg93ban9Dfgh8`, the header will look like this: + + + ``` + + X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8 + + ``` + + + **For security reasons, unused API keys expire after 90 days. When that + happens, you’ll need to generate a new key to use our API.** + + + ### Example authenticated request + + + ``` + + $ curl -H "X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8" + https://api.getresponse.com/v3/accounts + + ``` + + + ## OAuth 2.0 + + + To use OAuth 2.0 authentication, you need to get an "Access Token". For more + information on how to obtain a token, head to our dedicated page: [OAuth + 2.0](/#section/Authentication/Using-OAuth-2.0) + + + To authenticate a request using an Access Token, set the value of + `Authorization` header to "Bearer" followed by the Access Token. + + + ### Example + + + If the Access Token is `jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8` + + + ``` + + Authorization: Bearer jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8 + + ``` + + + ## GetResponse MAX + + + GetResponse MAX customers need to take an extra step to authenticate the + request. All requests have to be send with an `X-Domain` header that + contains the client's domain. For example: + + + ``` + + X-Domain: example.com + + ``` + + + Please note that the header must contain only the domain name, without the + protocol identifier (`http://` or `https://`). + + + ## Using OAuth 2.0 + + + ### Registering your own application + + + If you want to use an OAuth flow to authorize your application, first + [register your application](https://app.getresponse.com/authorizations) + + + You need to provide a name, short description, and redirect URL. + + + ### Choosing grant flow + + + Once your application is registered, you can click on it to see your + `client_id` and `client_secret`. They're basically a login and password for + your application's access, so be sure not to share them with anyone. + + + Next, decide which authentication flow (grant type) you want to use. Here + are your options: + + + - choose the **Authorization Code** flow if your application is server-based + (you have a server with its own domain and server-side code), + + - choose the **Implicit** flow if your application is based mostly on + JavaScript or client-side code, + + - choose the **Client Credential** flow if you want to test your application + or access your GetResponse account, + + - implement the **Refresh Token** flow to handle token expiration if you use + the Authorization Code flow. + + + ### Authorization Code flow + + + First, your application must redirect a resource owner to the following URL: + + + ``` + + https://app.getresponse.com/oauth2_authorize.html?response_type=code&client_id=_your_client_id_&state=xyz + + ``` + + + The `state` parameter is there for security reasons and should be a random + string. When the resource owner grants your application access to the + resource, we will redirect the browser to the `redirect URL` you specified + in the application settings and attach the same state as the parameter. + Comparing the state parameter value ensures that the redirect was initiated + by our system. The code parameter is an authorization code that you can + exchange for an access token within 10 minutes, after which time it expires. + + + #### Example redirect with authorization code + + + ``` + + https://myredirecturi.com/cb?code=ed17c498bfe343175cd7684c5b09979f2875b25c&state=xyz + + ``` + + + #### Exchanging authorization code for the access token + + + Here's an example request to exchange authorization code for the access + token: + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=authorization_code&code=ed17c498bfe343175cd7684c5b09979f2875b25c' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + ##### Example response + + + ```json + + { + "access_token": "03807cb390319329bdf6c777d4dfae9c0d3b3c35", + "expires_in": 3600, + "token_type": "Bearer", + "scope": null, + "refresh_token": "170d9f64e781aaa6b3ba036083faba71b2fc4e6c" + } + + ``` + + + ### Client Credentials flow + + + This flow is suitable for development, when you need to quickly access API + to create some functionality. You can get the access token with a single + request: + + + #### Request + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=client_credentials' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + #### Response + + + ```json + + { + "access_token": "e2222af2851a912470ec33c9b4de1ea3a304b7d7", + "expires_in": 86400, + "token_type": "Bearer", + "scope": null + } + + ``` + + + You can also go to https://app.getresponse.com/manage_api.html, click the + action button for your application, and select "generate credentials". This + will open a popup with a generated access token. You can then use the access + token to authenticate your requests, for example: + + + ``` + + $ curl -H "Authorization: Bearer e2222af2851a912470ec33c9b4de1ea3a304b7d7" + https://api.getresponse.com/v3/from-fields + + ``` + + + ### Implicit flow + + + First, your application must redirect a resource owner to the following URL: + + + ``` + + https://app.getresponse.com/oauth2_authorize.html?response_type=token&client_id=_your_client_id_&redirect_uri=https://myredirecturi.com/cb&state=xyz + + ``` + + + When the resource owner grants your application access to the resource, we + will redirect the owner to the URL that was specified in the request. + + + There is no code exchange process because, unlike the Authorization Code + flow, the redirect already has the access token in the parameters. + + + ``` + + https://myredirecturi.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA&state=xyz&token_type=bearer&expires_in=3600 + + ``` + + + ### Refresh Token flow + + + You need to refresh your access token if you receive this error message as a + response to your request: + + + ```json + + { + "httpStatus": 401, + "code": 1014, + "codeDescription": "Problem during authentication process, check headers!", + "message": "The access token provided is expired", + "moreInfo": "https://apidocs.getresponse.com/v3/errors/1014", + "context": { + "sentToken": "b8b1e961a7f9fd4cc710d5d955e09c15a364ab71" + } + } + + ``` + + + If you are using the Authorization Code flow, you need to use the refresh + token to issue a new access token/refresh token pair by making the following + request: + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=refresh_token&refresh_token=170d9f64e781aaa6b3ba036083faba71b2fc4e6c' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + The response you'll get will look like this: + + + ```json + + { + "access_token": "890fdsa2f5d7b189fc4e6c4b1d170d9f591238ss", + "expires_in": 86400, + "token_type": "Bearer", + "scope": null, + "refresh_token": "170d9f64e781aaa6b3ba036083faba71b2fc4e6c" + } + + ``` + + + ### GetResponse MAX + + + There are some differences when authenticating GetResponse MAX users: + + + - the application must redirect to a page in the client's custom domain, for + example: `https://custom-domain.getresponse360.com/oauth2_authorize.html` + + - token requests have to be send to one of the GetResponse MAX APIv3 + endpoints (depending on the client's environment), + + - token requests have to include an `X-Domain` header, + + - the application has to be registered in a GetResponse MAX account within + the same environment. + + + + # CORS (AJAX requests) + + + [Cross-Origin Resource Sharing + (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) mechanism is + not supported by APIv3. It means that AJAX requests to the API will be + blocked by the browser's [same-origin + policy](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy). + Please use a server-side application to access the API. + + + + # Timezone settings + + + The default timezone in response data is **UTC**. + + + To set a different timezone, add `X-Time-Zone` header with value of [time + zone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) + ("TZ database name" column). + + + + # Pagination + + + Most of the resource collections returned by API are paginated. It means + that the response is divided into multiple pages. + + + Control the number of results on each page by using `perPage` query + parameter and change pages by using `page` query parameter. + + + By default we return only the first **100** resources per page. You can + change that by adding `perPage` parameter with a value of up to **1000**. + + + Page numbers start with **1**. + + + Paginated responses have 3 extra headers: + + * `TotalCount` – a total number of resources on all pages + + * `TotalPages` – a total number of pages + + * `CurrentPage` – current page number + + + Use the maximum `perPage` value (**1000**) if you plan to iterate over all + the pages of the response. + + + When trying to get a page that exceeds the total number of pages, API will + return an empty array (`[]`). Make sure to stop iterating when it happens. + + + + # CURLE_SSL_CACERT error + + + Solution to CURLE_SSL_CACERT error (code 60). + + + This error is related to expired CA (Certificate Authority) certificates + installed on your server (the server that you send the requests from). You + can read more about certificate verification on the [cURL project + website](https://curl.haxx.se/docs/sslcerts.html). + + + If you encounter this error while sending requests to the GetResponse APIv3, + ask your server administrator to update the CA certificates using the + [latest bundle provided by the cURL + project](https://curl.haxx.se/docs/caextract.html). + + + **Please make sure that cURL is configured to use the updated bundle.** + version: 3.2024-03-04T09:53:07+0000 + contact: + name: API Support - DevZone + url: https://app.getresponse.com/feedback.html?devzone=yes + email: getresponse-devzone@cs.getresponse.com + x-logo: + url: https://us-ws.gr-cdn.com/images/global/getresponse.png + x-konfig-ignore: + object-with-no-properties: true + potential-incorrect-type: true +servers: + - description: GetResponse + url: https://api.getresponse.com/v3 + - description: GetResponse MAX US + url: https://api3.getresponse360.com/v3 + - description: GetResponse MAX PL + url: https://api3.getresponse360.pl/v3 +tags: + - name: Accounts + - description: >- + Our API v3 uses the terminology from the previous version of GetResponse. + + + **Campaigns and lists are the same resource under a different name.** For + now, please refer to lists as campaigns. + + + Our API v4 will use the updated terminology. + name: Campaigns (Lists) + - name: Contacts + - name: Newsletters + - name: Search Contacts + - name: File Library + - name: Autoresponders + - name: RSS Newsletters + - name: Products + - name: Custom Events + - name: From Fields + - name: Taxes + - name: Predefined Fields + - name: Categories + - name: Suppressions + - name: Orders + - name: Shops + - name: Carts + - name: Tags + - name: Addresses + - name: Custom Fields + - name: Product Variants + - name: Meta Fields + - name: Transactional Emails Templates + - name: Transactional Emails + - name: A/B tests - subject + - name: Forms + - name: Imports + - name: Workflows + - name: Webinars + - name: Legacy Landing Pages + - name: Subscription Confirmations + - name: Forms and Popups + - name: A/B tests + - description: >- + Click tracking refers to the data collected about each link click, such as + how many people clicked it, how many clicks resulted in desired actions + such as sales, forwards or subscriptions. + name: Click Tracks + - name: Multimedia + - name: Tracking + - name: Legacy Forms + - name: SMS Messages + - name: Websites + - name: Landing Pages + - name: GDPR Fields + - name: Ecommerce + - name: SMS Automation Messages + - name: Sms + - name: Form and Popup + - name: Landing Page + - name: Website + - name: Transactional Email Templates + - name: New Landing Pages +paths: + /webinars/{webinarId}: + parameters: + - $ref: '#/components/parameters/webinarId' + get: + tags: + - Webinars + summary: Get a webinar by ID + operationId: Webinars_getById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/WebinarDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /contacts/{contactId}: + parameters: + - $ref: '#/components/parameters/contactId' + get: + tags: + - Contacts + summary: Get contact details by contact ID + operationId: Contacts_getDetailsById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ContactDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Contacts + summary: Update contact details + operationId: Contacts_updateDetails + security: + - api-key: [] + - oauth2: + - all + description: >- + Skip the fields you don't want to update. If tags and custom fields are + provided, they'll be **replaced** with the values sent in this request. + If the `campaignId` changes, the contact will be moved from the original + campaign (list) to the new campaign (list). Their activity history and + statistics will also be moved. + requestBody: + $ref: '#/components/requestBodies/UpdateContact' + responses: + '200': + $ref: '#/components/responses/ContactDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Contacts + summary: Delete a contact by contact ID + operationId: Contacts_deleteById + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: >- + > + + The ID of a message (such as a newsletter, an autoresponder, or an + RSS-newsletter). + + When passed, this method will simulate the unsubscribe process, as + if the contact clicked the unsubscribe link in a given message. + name: messageId + in: query + required: false + schema: + type: string + - description: >- + This makes it possible to pass the IP from which the contact + unsubscribed. Used only if the `messageId` was send. + name: ipAddress + in: query + schema: + type: string + format: ipv4 + responses: + '204': + description: Empty response. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /contacts/{contactId}/activities: + parameters: + - $ref: '#/components/parameters/contactId' + get: + tags: + - Contacts + summary: Get a list of contact activities + operationId: Contacts_getListOfActivities + security: + - api-key: [] + - oauth2: + - all + description: >- + By default, only activities from the last 14 days are returned. To get + earlier data, use `query[createdOn]` parameter. You can filter the + resource using criteria specified as `query[*]`. You can provide + multiple criteria, to use AND logic. You can sort the resource using + parameters specified as `sort[*]`. You can specify multiple fields to + sort by. + parameters: + - name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ContactActivityList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /campaigns/{campaignId}/contacts: + parameters: + - $ref: '#/components/parameters/campaignId' + get: + tags: + - Contacts + summary: Get contacts from a single campaign + operationId: Contacts_getSingleCampaignContacts + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search contacts by email + name: query[email] + in: query + required: false + schema: + type: string + - description: Search contacts by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Count data from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Count data to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Sort contacts by email + name: sort[email] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort contacts by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort contacts by creation date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ContactList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /contacts/{contactId}/custom-fields: + parameters: + - $ref: '#/components/parameters/contactId' + post: + tags: + - Contacts + summary: Upsert the custom fields of a contact + operationId: Contacts_upsertCustomFields + security: + - api-key: [] + - oauth2: + - all + description: >- + Upsert (add or update) the custom fields of a contact. This method + doesn't remove (unassign) custom fields. + requestBody: + $ref: '#/components/requestBodies/UpsertContactCustomFields' + responses: + '200': + $ref: '#/components/responses/ContactCustomFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-type: upsert + /contacts/{contactId}/tags: + parameters: + - $ref: '#/components/parameters/contactId' + post: + tags: + - Contacts + summary: Upsert the tags of a contact + operationId: Contacts_upsertContactTags + security: + - api-key: [] + - oauth2: + - all + description: >- + Upsert (add or update) the tags of a contact. This method doesn't remove + (unassign) tags. + requestBody: + $ref: '#/components/requestBodies/UpsertContactTags' + responses: + '200': + $ref: '#/components/responses/UpsertContactTags' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-type: upsert + /search-contacts/{searchContactId}: + parameters: + - $ref: '#/components/parameters/searchContactId' + get: + tags: + - Search Contacts + summary: Get search contacts by contact ID. + operationId: SearchContacts_byContactId + security: + - api-key: [] + - oauth2: + - all + description: Get the definition of a specific contact-search filter. + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SearchContactsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Search Contacts + summary: Update search contacts + operationId: SearchContacts_updateSpecifiedContacts + security: + - api-key: [] + - oauth2: + - all + description: Update specified search contacts. + requestBody: + $ref: '#/components/requestBodies/UpdateSearchContacts' + responses: + '200': + $ref: '#/components/responses/SearchContactsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Search Contacts + summary: Delete search contacts + operationId: SearchContacts_deleteById + security: + - api-key: [] + - oauth2: + - all + responses: + '204': + description: Delete search contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /search-contacts/{searchContactId}/contacts: + parameters: + - $ref: '#/components/parameters/searchContactId' + get: + tags: + - Search Contacts + summary: Get contacts by search contacts ID + operationId: SearchContacts_byId + security: + - api-key: [] + - oauth2: + - all + description: Get contacts from saved search contacts by ID. + parameters: + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - description: Sort by email + name: sort[email] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - description: Sort by creation date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: asc + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SearchedContactsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /search-contacts/{searchContactId}/custom-fields: + parameters: + - $ref: '#/components/parameters/searchContactId' + post: + tags: + - Search Contacts + summary: Upsert custom fields by search contacts + operationId: SearchContacts_upsertCustomFieldsByContactId + security: + - api-key: [] + - oauth2: + - all + description: >- + Makes it possible to add and update custom field values for all contacts + that meet the search criteria. This method doesn't remove or overwrite + custom fields with the values from the request. + requestBody: + $ref: '#/components/requestBodies/UpsertContactCustomFields' + responses: + '202': + description: Upsert custom fields by searchContactId. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: UpsertCustomFieldsBySearchContactsId + /transactional-emails/templates/{transactionalTemplateId}: + parameters: + - $ref: '#/components/parameters/transactionalTemplateId' + get: + tags: + - Transactional Emails Templates + summary: Get a single template by ID + operationId: TransactionalEmailsTemplates_getById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailsTemplateDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + post: + tags: + - Transactional Emails Templates + summary: Update transactional email template + operationId: TransactionalEmailsTemplates_updateTemplate + security: + - api-key: [] + - oauth2: + - all + description: This method allows you to update transactional email template + requestBody: + $ref: '#/components/requestBodies/updateTransactionalEmailsTemplate' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailsTemplateDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + delete: + tags: + - Transactional Emails Templates + summary: Delete transactional email template + operationId: TransactionalEmailsTemplates_deleteTemplate + security: + - api-key: [] + - oauth2: + - all + responses: + '204': + description: Delete transactional email template + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /transactional-emails/{transactionalEmailId}: + parameters: + - $ref: '#/components/parameters/transactionalEmailId' + get: + tags: + - Transactional Emails + summary: Get transactional email details by transactional email ID + operationId: TransactionalEmails_getDetailsById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /from-fields/{fromFieldId}: + parameters: + - $ref: '#/components/parameters/fromFieldId' + get: + tags: + - From Fields + summary: Get a single 'From' address by ID + operationId: FromFields_getSingleAddressById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/FromFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - From Fields + summary: Delete 'From' address + operationId: FromFields_deleteAddress + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: The 'From' address ID that should replace the deleted 'From' address + name: fromFieldIdToReplaceWith + in: query + required: false + schema: + type: string + responses: + '204': + description: Delete 'From' address. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /from-fields/{fromFieldId}/default: + parameters: + - $ref: '#/components/parameters/fromFieldId' + post: + tags: + - From Fields + summary: Set a 'From' address as default + operationId: FromFields_setFromAddressAsDefault + security: + - api-key: [] + - oauth2: + - all + responses: + '200': + description: Set a 'From' address as default. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: SetDefaultFromField + x-no-body: true + x-type: update + /rss-newsletters/{rssNewsletterId}: + parameters: + - $ref: '#/components/parameters/rssNewsletterId' + get: + tags: + - RSS Newsletters + summary: Get RSS newsletter by ID + operationId: RssNewsletters_getById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/RssNewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - RSS Newsletters + summary: Update RSS newsletter + operationId: RssNewsletters_updateNewsletter + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/UpdateRssNewsletter' + responses: + '200': + $ref: '#/components/responses/RssNewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - RSS Newsletters + summary: Delete RSS newsletter + operationId: RssNewsletters_deleteNewsletter + security: + - api-key: [] + - oauth2: + - all + responses: + '204': + description: Delete RSS newsletter. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /rss-newsletters/{rssNewsletterId}/statistics: + parameters: + - $ref: '#/components/parameters/rssNewsletterId' + get: + tags: + - RSS Newsletters + summary: Get RSS newsletter statistics by ID + operationId: RssNewsletters_getStatisticsById + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Group results by time interval + name: query[groupBy] + in: query + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - description: Count data from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Count data to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SingleMessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: GetRssNewsletterStatistics + /shops/{shopId}/taxes: + parameters: + - $ref: '#/components/parameters/shopId' + get: + tags: + - Taxes + summary: Get a list of taxes + operationId: Taxes_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + + Sending **GET** request to this URL returns a collection of tax + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below, in the request params + section). You can basically search by: + * name + * createdOn + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + parameters: + - description: Search tax by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search tax created from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search tax created to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Sort by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TaxList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Taxes + summary: Create tax + operationId: Taxes_createNewTax + security: + - api-key: [] + - oauth2: + - all + description: > + + Sending a **POST** request to this URL will create a new tax resource. + + + In order to create a new tax, you need to send a tax resource in the + body of the request (remember that you need to serialize the body into a + JSON string) + requestBody: + $ref: '#/components/requestBodies/NewTax' + responses: + '201': + $ref: '#/components/responses/TaxDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: CreateTax + /shops/{shopId}/taxes/{taxId}: + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/taxId' + get: + tags: + - Taxes + summary: Get a single tax by ID + operationId: Taxes_getSingleById + security: + - api-key: [] + - oauth2: + - all + description: > + + This method returns tax with a given `taxId` in the context of a given + `shopId` + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TaxDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: GetTax + post: + tags: + - Taxes + summary: Update tax + operationId: Taxes_updateShopTax + security: + - api-key: [] + - oauth2: + - all + description: > + + Update the properties of the shop tax. You should only send the fields + that need to be changed. The rest of the properties will stay the same. + requestBody: + $ref: '#/components/requestBodies/UpdateTax' + responses: + '200': + $ref: '#/components/responses/TaxDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: UpdateTax + delete: + tags: + - Taxes + summary: Delete tax by ID + operationId: Taxes_deleteById + security: + - api-key: [] + - oauth2: + - all + description: '' + responses: + '204': + description: Delete tax + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: DeleteTax + /custom-events/{customEventId}: + parameters: + - $ref: '#/components/parameters/customEventId' + get: + tags: + - Custom Events + summary: Get custom events by custom event ID + operationId: CustomEvents_getById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CustomEventDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Custom Events + summary: Update custom event details + operationId: CustomEvents_updateDetails + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/UpdateCustomEvent' + responses: + '200': + $ref: '#/components/responses/CustomEventDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Custom Events + summary: Delete a custom event by custom event ID + operationId: CustomEvents_deleteEventById + security: + - api-key: [] + - oauth2: + - all + responses: + '204': + description: Delete custom event + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /forms/{formId}: + parameters: + - $ref: '#/components/parameters/formId' + get: + tags: + - Forms + summary: Get form by ID + operationId: Forms_getById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/FormDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /forms/{formId}/variants: + parameters: + - $ref: '#/components/parameters/formId' + get: + tags: + - Forms + summary: Get the list of form variants (A/B tests) + operationId: Forms_getListOfVariants + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/FormVariantList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /landing-pages/{landingPageId}: + parameters: + - $ref: '#/components/parameters/landingPageId' + get: + tags: + - Legacy Landing Pages + summary: Get single landing page by ID + operationId: LegacyLandingPages_getById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LandingPageDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /imports/{importId}: + parameters: + - $ref: '#/components/parameters/importId' + get: + tags: + - Imports + summary: Get import details by ID. + operationId: Imports_getImportDetailsById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ImportDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /statistics/sms/{smsId}: + parameters: + - $ref: '#/components/parameters/smsId' + get: + tags: + - Sms + summary: Get details for the SMS message statistics + operationId: Sms_getMessageStatistics + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: Get statistics for a single SMS from this date + name: query[createdOn][from] + in: query + schema: + type: string + format: date + example: '2023-01-20' + - description: Get statistics for a single SMS to this date + name: query[createdOn][to] + in: query + schema: + type: string + format: date + example: '2023-01-20' + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SmsStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /predefined-fields/{predefinedFieldId}: + parameters: + - $ref: '#/components/parameters/predefinedFieldId' + get: + tags: + - Predefined Fields + summary: Get a predefined field by ID + operationId: PredefinedFields_getById + security: + - api-key: [] + - oauth2: + - all + description: Get detailed information about a specified predefined field. + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/PredefinedFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Predefined Fields + summary: Update a predefined field + operationId: PredefinedFields_updateField + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/UpdatePredefinedField' + responses: + '200': + $ref: '#/components/responses/PredefinedFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Predefined Fields + summary: Delete a predefined field + operationId: PredefinedFields_deleteField + security: + - api-key: [] + - oauth2: + - all + responses: + '204': + description: Delete a predefined field. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /shops/{shopId}/categories: + parameters: + - $ref: '#/components/parameters/shopId' + get: + tags: + - Categories + summary: Get the shop categories list + operationId: Categories_list + security: + - api-key: [] + - oauth2: + - all + description: >- + + Sending a **GET** request to this URL returns a collection of category + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + *name + * createdOn + * parentId + + The `name` fields can be a pattern and we'll try to match this phrase. + + + The `parentId` will search for sub-categories of a given parent + category. + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + parameters: + - description: Search category by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search categories by their parent + name: query[parentId] + in: query + required: false + schema: + type: string + - description: Search categories by external ID + name: query[externalId] + in: query + required: false + schema: + type: string + - description: Show categories starting from this date + name: search[createdAt][from] + in: query + required: false + schema: + type: string + format: date-time + - description: Show categories starting to this date + name: search[createdAt][to] + in: query + required: false + schema: + type: string + format: date-time + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by date + name: sort[createdAt] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CategoryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Categories + summary: Create category + operationId: Categories_createNewCategory + security: + - api-key: [] + - oauth2: + - all + description: >+ + + Create shop category. You can pass the `parentId` parameter to create a + sub-category of a given parent. Unlike most **POST** methods, this call + is idempotent, that is: sending the same request 10 times will not + create 10 new categories. Only one category will be created. + + requestBody: + $ref: '#/components/requestBodies/NewCategory' + responses: + '201': + $ref: '#/components/responses/CategoryDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /shops/{shopId}/categories/{categoryId}: + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/categoryId' + get: + tags: + - Categories + summary: Get a single category by ID + operationId: Categories_getById + security: + - api-key: [] + - oauth2: + - all + description: | + + This method returns a category according to the given `categoryId`. + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CategoryDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Categories + summary: Update category + operationId: Categories_updateCategoryProperties + security: + - api-key: [] + - oauth2: + - all + description: >+ + + Update the properties of the shop category. You can specify a `parentId` + to assign a category as sub-category for an existing category. You + should send only those fields that need to be changed. The rest of the + properties will stay the same. + + requestBody: + $ref: '#/components/requestBodies/UpdateCategory' + responses: + '200': + $ref: '#/components/responses/CategoryDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Categories + summary: Delete category + operationId: Categories_deleteCategory + security: + - api-key: [] + - oauth2: + - all + description: '' + responses: + '204': + description: Delete category + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /suppressions/{suppressionId}: + parameters: + - $ref: '#/components/parameters/suppressionId' + get: + tags: + - Suppressions + summary: Get a suppression list by ID + operationId: Suppressions_getSuppressionListById + security: + - api-key: [] + - oauth2: + - all + responses: + '200': + $ref: '#/components/responses/SuppressionDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Suppressions + summary: Update a suppression list by ID + operationId: Suppressions_updateById + security: + - api-key: [] + - oauth2: + - all + requestBody: + description: The suppression list to be updated. + $ref: '#/components/requestBodies/UpdateSuppression' + responses: + '200': + $ref: '#/components/responses/SuppressionDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Suppressions + summary: Deletes a given suppression list by ID + operationId: Suppressions_deleteById + security: + - api-key: [] + - oauth2: + - all + responses: + '204': + description: Suppression list deleted successfully. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /shops/{shopId}/orders: + parameters: + - $ref: '#/components/parameters/shopId' + get: + tags: + - Orders + summary: Get the list of orders + operationId: Orders_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + + Sending a **GET** request to this URL returns a collection of order + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + * description + * status + * externalId + * processedAt + + The `description` fields can be a pattern and we'll try to match this + phrase. + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + parameters: + - description: Search order by description + name: query[description] + in: query + required: false + schema: + type: string + - description: Search order by status + name: query[status] + in: query + required: false + schema: + type: string + - description: Search order by external ID + name: query[externalId] + in: query + required: false + schema: + type: string + - description: Show orders processed from this date + name: query[processedAt][from] + in: query + required: false + schema: + type: string + format: date-time + - description: Show orders processed to this date + name: query[processedAt][to] + in: query + required: false + schema: + type: string + format: date-time + - description: Sort by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/OrderList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Orders + summary: Create order + operationId: Orders_createNewOrder + security: + - api-key: [] + - oauth2: + - all + description: >+ + + Sending a **POST** request to this URL will create a new order resource. + + + In order to create a new order, you need to send the order resource in + the body of the request (remember that you need to serialize the body + into a JSON string). + + parameters: + - description: >- + The additional flags parameter with the value `skipAutomation` will + skip the triggering `Make a purchase` element in an automated + workflow + name: additionalFlags + in: query + required: false + schema: + type: string + example: skipAutomation + x-set: + - skipAutomation + requestBody: + $ref: '#/components/requestBodies/NewOrder' + responses: + '201': + $ref: '#/components/responses/OrderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /shops/{shopId}/orders/{orderId}: + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/orderId' + get: + tags: + - Orders + summary: Get a single order by ID + operationId: Orders_getById + security: + - api-key: [] + - oauth2: + - all + description: |+ + + This method returns the order according to the given `orderId`. + + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/OrderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Orders + summary: Update order + operationId: Orders_updateOrder + security: + - api-key: [] + - oauth2: + - all + description: >+ + + Update the properties of a shop's order. You should send only those + fields that need to be changed. The rest of the properties will stay the + same. + + However, in case of `billingAddress` and `shippingAddress`, you must + send the entire representation. Individual fields can't be updated. + + If you want to update individual fields of an address, you can do so + using `POST /v3/addresses/{addressId}`. + + + In case of `selectedVariants`, when the collection is updated, the old + collection is completely removed. The same goes for meta fields. + + Individual fields can't be updated either. The full representations of + `selectedVariants` and `metaFields` must be sent instead. + + parameters: + - description: >- + The additional flags parameter with the value `skipAutomation` will + skip the triggering `Make a purchase` element in an automated + workflow + name: additionalFlags + in: query + required: false + schema: + type: string + example: skipAutomation + x-set: + - skipAutomation + requestBody: + $ref: '#/components/requestBodies/UpdateOrder' + responses: + '200': + $ref: '#/components/responses/OrderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Orders + summary: Delete order + operationId: Orders_deleteOrder + security: + - api-key: [] + - oauth2: + - all + description: '' + responses: + '204': + description: Delete order + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /shops/{shopId}/products: + parameters: + - $ref: '#/components/parameters/shopId' + get: + tags: + - Products + summary: Get a product list. + operationId: Products_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + + Sending a **GET** request to this URL returns a collection of product + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + * name + * vendor + * category + * categoryId + * externalId + * variantName + * metaFieldNames + * metaFieldValues + * createdOn + + The `metaFieldNames` and `metaFieldValues` fields can be a list of + values separated by a comma [,]. + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + parameters: + - description: Search products by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search products by vendor + name: query[vendor] + in: query + required: false + schema: + type: string + - description: Search products by category name + name: query[category] + in: query + required: false + schema: + type: string + - description: Search products by category ID + name: query[categoryId] + in: query + required: false + schema: + type: string + - description: Search products by external ID + name: query[externalId] + in: query + required: false + schema: + type: string + - description: Search products by product variant name + name: query[variantName] + in: query + required: false + schema: + type: string + - description: >- + Search products by meta field name (the list of names must be + separated by a comma [,]) + name: query[metaFieldNames] + in: query + required: false + schema: + type: string + - description: >- + Search products by meta field value (the list of values must be + separated by a comma [,]) + name: query[metaFieldValues] + in: query + required: false + schema: + type: string + - description: Search products created from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search products created to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ProductList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Products + summary: Create product + operationId: Products_createProduct + security: + - api-key: [] + - oauth2: + - all + description: >+ + + Sending a **POST** request to this URL will create a new product + resource. + + + In order to create a new product, you need to send the product resource + in the body of the request (remember that you need to serialize the body + into a JSON string) + + + You don't need a separate endpoint for each element (e.g. variant, + category, meta-field). You can create them all with this method. + + + Please note that categories aren't required, but if a product has at + least one category, then one of those categories must be marked as + default. + + This can be set by field `isDefault`. If none of the elements contains + isDefault=true, then the system picks the first one from the collection + by default. + + requestBody: + $ref: '#/components/requestBodies/NewProduct' + responses: + '201': + $ref: '#/components/responses/ProductDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /shops/{shopId}/products/{productId}: + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + get: + tags: + - Products + summary: Get a single product by ID + operationId: Products_getByShopIdAndProductId + security: + - api-key: [] + - oauth2: + - all + description: >+ + + This method returns product according to the given `productId` in the + context of a given `shopId`. + + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ProductDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Products + summary: Update product + operationId: Products_updateProduct + security: + - api-key: [] + - oauth2: + - all + description: >+ + + Update the properties of a shop's product. You should only send those + fields that need to be changed. The remaining properties will stay the + same. + + However, when updating variants, categories, and meta fields, you need + to send entire collections. Individual fields can't be updated. + + If you want to update particular fields, you can do so using their + specific endpoints, i.e.: + + * categories - `POST /v3/shops/{shopId}/categories/{categoryId}` + * variants - POST `/v3/shops/{shopId}/products/{productId}/variants/{variantId}` + * metaFields - `POST /v3/shops/{shopId}/meta-fields/{metaFieldId}` + + + requestBody: + $ref: '#/components/requestBodies/UpdateProduct' + responses: + '200': + $ref: '#/components/responses/ProductDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Products + summary: Delete product + operationId: Products_deleteProduct + security: + - api-key: [] + - oauth2: + - all + description: '' + responses: + '204': + description: Delete product + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /shops/{shopId}/products/{productId}/categories: + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + post: + tags: + - Products + summary: Upsert product categories + operationId: Products_upsertCategories + security: + - api-key: [] + - oauth2: + - all + description: >+ + + This method makes it possible to assign product categories, and to set a + default product category. This method doesn't remove or unassign product + categories. It returns a list of product categories. + + + Please note that if you assign only one category to a given product, + that category is marked as default. If you try to remove the default + mark, your change won't be executed. + + requestBody: + $ref: '#/components/requestBodies/UpsertProductCategory' + responses: + '200': + $ref: '#/components/responses/SimpleProductCategoryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-type: upsert + /shops/{shopId}/products/{productId}/meta-fields: + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + post: + tags: + - Products + summary: Upsert product meta fields + operationId: Products_upsertMetaFields + security: + - api-key: [] + - oauth2: + - all + description: >+ + + This method makes it possible to assign meta fields. It doesn't remove + or unassign meta fields. It returns a list of product meta fields. + + requestBody: + $ref: '#/components/requestBodies/UpsertMetaField' + responses: + '200': + $ref: '#/components/responses/MetaFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-type: upsert + /shops/{shopId}: + parameters: + - $ref: '#/components/parameters/shopId' + get: + tags: + - Shops + summary: Get a single shop by ID + operationId: Shops_getById + security: + - api-key: [] + - oauth2: + - all + description: |+ + + This method returns the shop according to the given `shopId` + + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ShopDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Shops + summary: Update shop + operationId: Shops_updatePreferences + security: + - api-key: [] + - oauth2: + - all + description: >+ + + This makes it possible to update shop preferences. You should send only + those fields that need to be changed. The rest of the properties remain + the same. + + requestBody: + $ref: '#/components/requestBodies/UpdateShop' + responses: + '200': + $ref: '#/components/responses/ShopDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Shops + summary: Delete shop + operationId: Shops_deleteShop + security: + - api-key: [] + - oauth2: + - all + description: |+ + + This method deletes a shop. + + responses: + '204': + description: Delete a shop + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /popups/{popupId}: + parameters: + - $ref: '#/components/parameters/popupId' + get: + tags: + - Forms and Popups + summary: Get a single form or popup by ID + operationId: FormsAndPopups_getFormOrPopupById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/PopupDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /statistics/popups/{popupId}/performance: + parameters: + - $ref: '#/components/parameters/popupId' + get: + tags: + - Form and Popup + summary: Get statistics for a single form or popup + operationId: FormAndPopup_getPerformanceStatsSinglePopup + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: Get statistics for a single form or popup from this date + name: query[date][from] + in: query + required: false + schema: + type: string + format: date + example: '2023-01-10' + - description: Get statistics for a single form or popup to this date + name: query[date][to] + in: query + required: false + schema: + type: string + format: date + example: '2023-01-20' + - description: Form or popup statistics by location + name: query[location] + in: query + required: false + schema: + type: string + - description: Form or popup statistics by device + name: query[device] + in: query + required: false + schema: + type: string + enum: + - desktop + - mobile + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/PopupGeneralPerformance' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /splittests/{splittestId}: + parameters: + - $ref: '#/components/parameters/splittestId' + get: + tags: + - A/B tests + summary: Get a single A/B test. + operationId: AbTests_getSingleAbTestById + security: + - api-key: [] + - oauth2: + - all + description: Get a single A/B test by ID. + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/Splittest' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /shops/{shopId}/carts: + parameters: + - $ref: '#/components/parameters/shopId' + get: + tags: + - Carts + summary: Get shop carts + operationId: Carts_getShopCarts + security: + - api-key: [] + - oauth2: + - all + description: >- + + Sending a **GET** request to this URL returns a collection of cart + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * externalId + * createdOn + + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + parameters: + - description: Search carts created from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search carts created to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search cart by external ID + name: query[externalId] + in: query + required: false + schema: + type: string + - description: Sort by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CartList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Carts + summary: Create cart + operationId: Carts_createNewCart + security: + - api-key: [] + - oauth2: + - all + description: >+ + + Sending a **POST** request to this URL will create a new cart resource. + + + In order to create a new cart, you need to send the cart resource in the + body of the request (remember that you need to serialize the body into a + JSON string) + + requestBody: + $ref: '#/components/requestBodies/NewCart' + responses: + '201': + $ref: '#/components/responses/CartDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /shops/{shopId}/carts/{cartId}: + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/cartId' + get: + tags: + - Carts + summary: Get cart by ID + operationId: Carts_getByIdInShopContext + security: + - api-key: [] + - oauth2: + - all + description: >+ + + This method returns cart with the given `cartId` in the context of a + given `shopId` + + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CartDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Carts + summary: Update cart + operationId: Carts_updateCartProperties + security: + - api-key: [] + - oauth2: + - all + description: >+ + + Update properties of the shop cart. You should send only those fields + that need to be changed. The rest of the properties will stay the same. + + + In case of selectedVariants, when the collection is updated, the old one + is completely removed. + + requestBody: + $ref: '#/components/requestBodies/UpdateCart' + responses: + '200': + $ref: '#/components/responses/CartDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Carts + summary: Delete cart + operationId: Carts_deleteCart + security: + - api-key: [] + - oauth2: + - all + description: '' + responses: + '204': + description: Delete cart + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /file-library/files/{fileId}: + parameters: + - $ref: '#/components/parameters/fileId' + get: + tags: + - File Library + summary: Get file by ID + operationId: FileLibrary_getFileById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/File' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - File Library + summary: Delete file by file ID + operationId: FileLibrary_deleteFileById + security: + - api-key: [] + - oauth2: + - all + responses: + '204': + description: Delete file + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /file-library/folders/{folderId}: + parameters: + - $ref: '#/components/parameters/folderId' + delete: + tags: + - File Library + summary: Delete folder by folder ID + operationId: FileLibrary_deleteFolderById + security: + - api-key: [] + - oauth2: + - all + responses: + '204': + description: Delete folder + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /ab-tests/subject/{abTestId}: + parameters: + - $ref: '#/components/parameters/abTestId' + get: + tags: + - A/B tests - subject + summary: Get a single A/B test by ID + operationId: AbTestsSubject_getSingleById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AbtestsSubjectGetDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /ab-tests/subject/{abTestId}/winner: + parameters: + - $ref: '#/components/parameters/abTestId' + post: + tags: + - A/B tests - subject + summary: Choose A/B test winner + operationId: AbTestsSubject_chooseWinner + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/ChooseWinnerAbtestsSubject' + responses: + '204': + description: Choose A/B test winner + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /click-tracks/{clickTrackId}: + parameters: + - $ref: '#/components/parameters/clickTrackId' + get: + tags: + - Click Tracks + summary: Get click tracked link details by click track ID + operationId: ClickTracks_getLinkDetailsById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ClickTrack' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /newsletters/{newsletterId}: + parameters: + - $ref: '#/components/parameters/newsletterId' + get: + tags: + - Newsletters + summary: Get a single newsletter by its ID. + operationId: Newsletters_getSingleById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Newsletters + summary: Delete newsletter + operationId: Newsletters_deleteNewsletter + security: + - api-key: [] + - oauth2: + - all + responses: + '204': + description: Delete newsletter. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /newsletters/{newsletterId}/activities: + parameters: + - $ref: '#/components/parameters/newsletterId' + get: + tags: + - Newsletters + summary: Get newsletter activities + operationId: Newsletters_getActivities + security: + - api-key: [] + - oauth2: + - all + description: >- + By default, activities from the **last 14 days** are listed only. You + can get activities for last 30 days only. You can filter the resource + using criteria specified as `query[*]`. You can provide multiple + criteria, to use AND logic. You can sort the resource using parameters + specified as `sort[*]`. You can specify multiple fields to sort by. + parameters: + - description: Search newsletter activities by activity type + name: query[activity] + in: query + required: false + schema: + type: string + enum: + - send + - open + - click + - description: >- + Search newsletter activities from this date. Default value is 14 + days earlier. You can get activities for last 30 days only. + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search newsletter activities to this date. Default value is now + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Sort by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/NewsletterActivities' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /newsletters/{newsletterId}/cancel: + parameters: + - $ref: '#/components/parameters/newsletterId' + post: + tags: + - Newsletters + summary: Cancel sending the newsletter + operationId: Newsletters_cancelSending + security: + - api-key: [] + - oauth2: + - all + description: > + > + + Using this method, you can cancel the sending of the newsletter. It will + also turn the newsletter into a **draft**. + responses: + '200': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: CancelNewsletter + x-no-body: true + /newsletters/{newsletterId}/thumbnail: + parameters: + - $ref: '#/components/parameters/newsletterId' + get: + tags: + - Newsletters + summary: Get newsletter thumbnail + operationId: Newsletters_getThumbnail + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: The size of the thumbnail + name: size + in: query + required: false + schema: + type: string + default: default + enum: + - default + - small + responses: + '200': + description: The newsletter thumbnail. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + image/*: + schema: + $ref: '#/components/schemas/NewslettersGetThumbnailResponse' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-type: get + x-operation-class-name: GetNewsletterThumbnail + /newsletters/{newsletterId}/statistics: + parameters: + - $ref: '#/components/parameters/newsletterId' + get: + tags: + - Newsletters + summary: The statistics of single newsletter + operationId: Newsletters_getStatistics + security: + - api-key: [] + - oauth2: + - all + description: >- + > + + This makes it possible to easily fetch statistics for a single + newsletter. You can group the data hourly, daily, monthly and as a + + total sum. Remember that all statistics date ranges are given in + standard UTC period type objects. + + ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)). + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + parameters: + - description: Group results by time interval + name: query[groupBy] + in: query + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - description: Count data from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Count data to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SingleMessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: GetNewsletterStatistics + /tags/{tagId}: + parameters: + - $ref: '#/components/parameters/tagId' + get: + tags: + - Tags + summary: Get tag by ID + operationId: Tags_getById + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: The tag ID + name: tagId + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TagDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Tags + summary: Update tag by ID + operationId: Tags_updateById + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/UpdateTag' + responses: + '200': + $ref: '#/components/responses/TagDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Tags + summary: Delete tag by ID + operationId: Tags_deleteById + security: + - api-key: [] + - oauth2: + - all + responses: + '204': + description: Tag deleted successfully. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /addresses/{addressId}: + parameters: + - $ref: '#/components/parameters/addressId' + get: + tags: + - Addresses + summary: Get an address by ID + operationId: Addresses_getAddressById + security: + - api-key: [] + - oauth2: + - all + description: '' + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AddressDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Addresses + summary: Update address + operationId: Addresses_updateAddress + security: + - api-key: [] + - oauth2: + - all + description: > + + Update an existing address. You should send only those fields that need + to be changed. The rest of the properties will stay the same. + requestBody: + $ref: '#/components/requestBodies/UpdateAddress' + responses: + '200': + $ref: '#/components/responses/AddressDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Addresses + summary: Delete address + operationId: Addresses_deleteAddress + security: + - api-key: [] + - oauth2: + - all + description: '' + responses: + '204': + description: Empty response + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /campaigns/{campaignId}/blocklists: + parameters: + - $ref: '#/components/parameters/campaignId' + get: + tags: + - Campaigns (Lists) + summary: Returns campaign blocklist masks + operationId: CampaignsLists_getBlocklistMasks + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: Blocklist mask to search for + name: query[mask] + in: query + required: false + schema: + type: string + example: '@somedomain.com' + responses: + '200': + $ref: '#/components/responses/CampaignBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Campaigns (Lists) + summary: Updates campaign blocklist masks + operationId: CampaignsLists_updateBlocklistMasks + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: >- + The flag value `add` adds the masks provided in the request body to + your blocklist. The flag value `delete` deletes the masks. The masks + are replaced if there are no flag values in the request body. + + For better performance, use the flag value `noResponse`. It removes the response body and can be used alone or combined with other flags. If multiple flags are used, separate them by a comma, like this: `additionalFlags=noResponse` or `additionalFlags=add,noResponse`. + name: additionalFlags + in: query + required: false + schema: + type: string + enum: + - add + - delete + - noResponse + requestBody: + $ref: '#/components/requestBodies/UpdateCampaignBlocklist' + responses: + '200': + $ref: '#/components/responses/CampaignBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-type: update + /custom-fields/{customFieldId}: + parameters: + - $ref: '#/components/parameters/customFieldId' + get: + tags: + - Custom Fields + summary: Get a single custom field definition by the custom field ID + operationId: CustomFields_getDefinitionById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CustomFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Custom Fields + summary: Update the custom field definition + operationId: CustomFields_updateDefinition + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/UpdateCustomField' + responses: + '200': + $ref: '#/components/responses/CustomFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Custom Fields + summary: Delete a single custom field definition + operationId: CustomFields_deleteSingleCustomField + security: + - api-key: [] + - oauth2: + - all + responses: + '204': + description: Delete a custom field. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /lps/{lpsId}: + parameters: + - $ref: '#/components/parameters/lpsId' + get: + tags: + - Landing Pages + summary: Get a single landing page by ID + operationId: LandingPages_getById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LpsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /statistics/lps/{lpsId}/performance: + parameters: + - $ref: '#/components/parameters/lpsId' + get: + tags: + - Landing Page + summary: Get details for landing page statistics + operationId: LandingPage_getPerformanceDetails + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: Show a single landing page statistics from this date + name: query[date][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Show a single landing page statistics to this date + name: query[date][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Landing page statistics by location + name: query[location] + in: query + required: false + schema: + type: string + - description: Landing page statistics by device + name: query[device] + in: query + required: false + schema: + type: string + enum: + - desktop + - mobile + - description: Landing page statistics by page UUID + name: query[page] + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LpsStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /shops/{shopId}/products/{productId}/variants: + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + get: + tags: + - Product Variants + summary: Get a list of product variants + operationId: ProductVariants_getProductVariantsList + security: + - api-key: [] + - oauth2: + - all + description: >+ + + Sending a **GET** request to this URL returns a collection of product + variant resources that belong to the given shop and product. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + + * sku + + * description + + + The `description` fields can be a pattern and we'll try to match this + phrase. + + parameters: + - description: Search variant by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search variant by SKU + name: query[sku] + in: query + required: false + schema: + type: string + - description: Search variant by description + name: query[description] + in: query + required: false + schema: + type: string + - description: Search variant by external ID + name: query[externalId] + in: query + required: false + schema: + type: string + - description: Show variants starting from this date + name: query[createdAt][from] + in: query + required: false + schema: + type: string + format: date-time + - description: Show variants starting to this date + name: query[createdAt][to] + in: query + required: false + schema: + type: string + format: date-time + - description: Sort by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ProductVariantList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Product Variants + summary: Create product variant + operationId: ProductVariants_createNewVariant + security: + - api-key: [] + - oauth2: + - all + description: >+ + + Sending a **POST** request to this URL will create a new product variant + resource. + + + In order to create a new product variant, you need to send a product + variant resource in the body of the request (remember that you need to + serialize the body into a JSON string) + + + There is no need to create every element (like: image, meta field, tax) + one by one by their own endpoints. All these elements can be created + during this method. + + requestBody: + $ref: '#/components/requestBodies/NewProductVariant' + responses: + '201': + $ref: '#/components/responses/ProductVariantDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /shops/{shopId}/products/{productId}/variants/{variantId}: + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + - $ref: '#/components/parameters/variantId' + get: + tags: + - Product Variants + summary: Get a single product variant by ID + operationId: ProductVariants_getById + security: + - api-key: [] + - oauth2: + - all + description: >+ + + This method returns product variant according to the given `variantId` + in the context of a given `shopId` and `productId` + + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ProductVariantDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Product Variants + summary: Update product variant + operationId: ProductVariants_updateVariantProperties + security: + - api-key: [] + - oauth2: + - all + description: >+ + + Update properties of a product variant. You should send only those + fields that need to be changed. The remaining properties will stay the + same. However, when updating metafields, images, and taxes, you need to + send entire collections. Individual fields can't be updated. If you want + to update particular metafields or tax resources, you can do so using + their particular endpoints, i.e: + + * taxes - `POST /v3/shops/{shopId}/taxes/{taxId}` + * metaFields - `POST /v3/shops/{shopId}/meta-fields/{metaFieldId}` + + requestBody: + $ref: '#/components/requestBodies/UpdateProductVariant' + responses: + '200': + $ref: '#/components/responses/ProductVariantDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Product Variants + summary: Delete product variant + operationId: ProductVariants_deleteVariant + security: + - api-key: [] + - oauth2: + - all + description: '' + responses: + '204': + description: Delete product variant + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /campaigns/{campaignId}: + parameters: + - $ref: '#/components/parameters/campaignId' + get: + tags: + - Campaigns (Lists) + summary: Get a single campaign by the campaign ID + operationId: CampaignsLists_getSingleCampaign + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/Campaign' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Campaigns (Lists) + summary: Update a campaign + operationId: CampaignsLists_updateCampaign + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/UpdateCampaign' + responses: + '200': + $ref: '#/components/responses/Campaign' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /shops/{shopId}/meta-fields: + parameters: + - $ref: '#/components/parameters/shopId' + get: + tags: + - Meta Fields + summary: Get the shop meta fields + operationId: MetaFields_getCollection + security: + - api-key: [] + - oauth2: + - all + description: >- + + Sending a **GET** request to this URL returns a collection of meta field + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + * value + * description + * createdOn + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + parameters: + - description: Search meta fields by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search meta fields by description + name: query[description] + in: query + required: false + schema: + type: string + - description: Search meta fields by value + name: query[value] + in: query + required: false + schema: + type: string + - description: Search meta fields created from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search meta fields created to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Sort by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MetaFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Meta Fields + summary: Create meta field + operationId: MetaFields_createNewMetaField + security: + - api-key: [] + - oauth2: + - all + description: > + + Sending a **POST** request to this URL will create a new meta field + resource. + + + In order to create a new meta field, you need to send a meta field + resource in the body of the request (remember that you need to serialize + the body into a JSON string) + requestBody: + $ref: '#/components/requestBodies/NewMetaField' + responses: + '201': + $ref: '#/components/responses/MetaFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /shops/{shopId}/meta-fields/{metaFieldId}: + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/metaFieldId' + get: + tags: + - Meta Fields + summary: Get the meta field by ID + operationId: MetaFields_getById + security: + - api-key: [] + - oauth2: + - all + description: > + + This method returns meta field with a given `metaFieldId` in the context + of a given `shopId` + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/MetaFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Meta Fields + summary: Update meta field + operationId: MetaFields_updateProperties + security: + - api-key: [] + - oauth2: + - all + description: > + + Update the properties of a shop's meta field. You should send only those + fields that need to be changed. The rest of the properties will stay the + same. + requestBody: + $ref: '#/components/requestBodies/UpdateMetaField' + responses: + '200': + $ref: '#/components/responses/MetaFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Meta Fields + summary: Delete meta field + operationId: MetaFields_delete + security: + - api-key: [] + - oauth2: + - all + description: '' + responses: + '204': + description: Delete meta field + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /webforms/{webformId}: + parameters: + - $ref: '#/components/parameters/webformId' + get: + tags: + - Legacy Forms + summary: Get Legacy Form by ID. + operationId: LegacyForms_getById + security: + - api-key: [] + - oauth2: + - all + description: Get Legacy Form by ID. + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LegacyForm' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /gdpr-fields/{gdprFieldId}: + parameters: + - $ref: '#/components/parameters/gdprFieldId' + get: + tags: + - GDPR Fields + summary: Get GDPR Field details + operationId: GdprFields_getDetails + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/GDPRFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /workflow/{workflowId}: + parameters: + - $ref: '#/components/parameters/workflowId' + get: + tags: + - Workflows + summary: Get workflow by ID + operationId: Workflows_getById + security: + - api-key: [] + - oauth2: + - all + description: Get a single workflow by ID. + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/Workflow' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Workflows + summary: Update workflow + operationId: Workflows_updateSingleWorkflow + security: + - api-key: [] + - oauth2: + - all + description: Update single workflow. + requestBody: + $ref: '#/components/requestBodies/UpdateWorkflow' + responses: + '200': + $ref: '#/components/responses/Workflow' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /sms/{smsId}: + parameters: + - $ref: '#/components/parameters/smsId' + get: + tags: + - SMS Messages + summary: Get a single SMS message by its ID + operationId: SmsMessages_getById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SmsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /autoresponders/{autoresponderId}: + parameters: + - $ref: '#/components/parameters/autoresponderId' + get: + tags: + - Autoresponders + summary: Get a single autoresponder by its ID + operationId: Autoresponders_getById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AutoresponderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Autoresponders + summary: Update autoresponder + operationId: Autoresponders_updateAutoresponder + security: + - api-key: [] + - oauth2: + - all + description: > + > + + **The action-based autoresponder feature has been migrated over to + marketing automation. Your existing autoresponders are + + now converted into workflows. You can no longer create and update + action-based autoresponders using our API.** + + + This method allows you to update an autoresponder. The same rules as in + creating an autoresponder apply. + requestBody: + $ref: '#/components/requestBodies/UpdateAutoresponder' + responses: + '200': + $ref: '#/components/responses/AutoresponderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + delete: + tags: + - Autoresponders + summary: Delete autoresponder. + operationId: Autoresponders_deleteById + security: + - api-key: [] + - oauth2: + - all + responses: + '204': + description: Delete autoresponder + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /autoresponders/{autoresponderId}/thumbnail: + parameters: + - $ref: '#/components/parameters/autoresponderId' + get: + tags: + - Autoresponders + summary: Get the autoresponder thumbnail + operationId: Autoresponders_getThumbnail + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: The size of the autoresponder thumbnail + name: size + in: query + required: false + schema: + type: string + default: default + enum: + - default + - small + responses: + '200': + description: The autoresponder thumbnail. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + image/*: + schema: + $ref: '#/components/schemas/AutorespondersGetThumbnailResponse' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-type: get + x-operation-class-name: GetAutoresponderThumbnail + /autoresponders/{autoresponderId}/statistics: + parameters: + - $ref: '#/components/parameters/autoresponderId' + get: + tags: + - Autoresponders + summary: The statistics for a single autoresponder + operationId: Autoresponders_getStatistics + security: + - api-key: [] + - oauth2: + - all + description: >- + > + + This requst returns the statistics summary for a single given + autoresponder. As in all statistics, you can change the date and time + range (hourly daily monthly or total). Keep in mind + + that all statistics date ranges are given in standard UTC period type + objects. ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)) + + + (https://app.getresponse.com/statistics.html?t=followup#total). + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + parameters: + - description: Group results by time interval + name: query[groupBy] + in: query + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - description: Count data from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Count data to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SingleMessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: GetAutoresponderStatistics + /websites/{websiteId}: + parameters: + - $ref: '#/components/parameters/websiteId' + get: + tags: + - Websites + summary: Get a single Website by ID + operationId: Websites_getById + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/WebsiteDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /statistics/wbe/{websiteId}/performance: + parameters: + - $ref: '#/components/parameters/websiteId' + get: + tags: + - Website + summary: Get details for website statistics + operationId: Website_getPerformanceDetails + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: Show a single website statistics from this date + name: query[date][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Show a single website statistics to this date + name: query[date][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Website statistics by location + name: query[location] + in: query + required: false + schema: + type: string + - description: Website statistics by device + name: query[device] + in: query + required: false + schema: + type: string + enum: + - desktop + - mobile + - description: Website statistics by a page UUID + name: query[page] + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/WebsiteStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /webinars: + get: + tags: + - Webinars + summary: Get a list of webinars + operationId: Webinars_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search webinars by name + name: query[name] + in: query + required: false + schema: + type: string + - description: The list of campaign resource IDs (string separated with ',') + name: query[campaignId] + in: query + required: false + schema: + type: string + - description: Search webinars by status + name: query[status] + in: query + required: false + schema: + type: string + enum: + - upcoming + - finished + - published + - unpublished + - description: Sort webinars by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort webinars by creation date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort webinars by update date + name: sort[startsOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Search webinars by type + name: query[type] + in: query + required: false + schema: + type: string + enum: + - all + - live + - on_demand + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/WebinarList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /contacts: + get: + tags: + - Contacts + summary: Get contact list + operationId: Contacts_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search contacts by email + name: query[email] + in: query + required: false + schema: + type: string + - description: Search contacts by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search contacts by campaign ID + name: query[campaignId] + in: query + required: false + schema: + type: string + - description: Search contacts by origin + name: query[origin] + in: query + required: false + schema: + type: string + enum: + - import + - email + - www + - panel + - leads + - sale + - api + - forward + - survey + - iphone + - copy + - landing_page + - webinar + - website_builder_elegant + - description: Count data from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Count data to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search contacts edited from this date + name: query[changedOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search contacts edited to this date + name: query[changedOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Sort by email + name: sort[email] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by change date + name: sort[changedOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by campaign ID + name: sort[campaignId] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: >- + The additional flags parameter with the value 'exactMatch' will + search for contacts with the exact value of the email and name + provided in the query string. Without this flag, matching is done + via a standard 'like' comparison, which may sometimes be slow. + name: additionalFlags + in: query + required: false + schema: + type: string + x-set: + - exactMatch + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ContactList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Contacts + summary: Create a new contact + operationId: Contacts_createNewContact + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/NewContact' + responses: + '202': + description: >- + > + + If the request is successful, the API returns the HTTP code **202 + Accepted**. + + This means that the contact has been preliminarily validated and + added to the queue. + + It may take a few minutes to process the queue and add the contact + to the list. If your contact didn't appear on the list, there's a + possibility that it was rejected at a later stage of processing. + + + ### Double opt-in + + + Campaigns can be set to double opt-in. + + This means that the contact has to click a link in a confirmation + message before they can be added to your list. + + Unconfirmed contacts are not returned by the API and can only be + found using Search Contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /contacts/batch: + post: + tags: + - Contacts + summary: Create multiple contacts at once + operationId: Contacts_createBatchContacts + security: + - api-key: [] + - oauth2: + - all + description: >- + This endpoint lets you create multiple contacts in one request. + + + **Note** + + + This endpoint is subject to special limits and throttling. You can make + 80 calls per time frame (10 minutes). The allowed batch size is 1000 + contacts. For more information, check our [API + Docs](https://apidocs.getresponse.com/v3/case-study/adding-batch-contacts). + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContactsCreateBatchContactsRequest' + responses: + '202': + description: >- + > + + If the request is successful, the API returns the HTTP code **202 + Accepted**. + + This means that the contacts has been preliminarily validated and + added to the queue. + + It may take a few minutes to process the queue and add the contacts + to the list. If your contact doesn't appear on the list, they were + likely rejected during the late processing stages. + + + ### Double opt-in + + + Campaigns (lists) can be set to use double opt-in. + + This means that a contact has to click a link in a confirmation + message before they can be added to your list. + + Unconfirmed contacts are not returned by API and can only be found + using Search Contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /search-contacts: + get: + tags: + - Search Contacts + summary: Get a saved search contact list + operationId: SearchContacts_savedList + security: + - api-key: [] + - oauth2: + - all + description: >- + Makes it possible to retrieve a collection of short representations of + search-contact (known as custom filters in the panel). Every item + represents a basic filter object. You can filter the resource using + criteria specified as `query[*]`. You can provide multiple criteria, to + use AND logic. You can sort the resource using parameters specified as + `sort[*]`. You can specify multiple fields to sort by. + parameters: + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - description: Sort by creation date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: asc + - description: Search by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Count data from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Count data to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/BaseSearchContactsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Search Contacts + summary: Create search contacts + operationId: SearchContacts_createNewSearch + security: + - api-key: [] + - oauth2: + - all + description: >- + Makes it possible to create a new search-contact. Please refer to + [Segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual) + requestBody: + $ref: '#/components/requestBodies/NewSearchContacts' + responses: + '201': + $ref: '#/components/responses/SearchContactsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /search-contacts/contacts: + post: + tags: + - Search Contacts + summary: Search contacts using conditions + operationId: SearchContacts_usingConditions + security: + - api-key: [] + - oauth2: + - all + description: >- + Makes it possible to get a collection of contacts according to a given + condition. Please refer to [Segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual) + parameters: + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - description: Sort by email + name: sort[email] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - description: Sort by creation date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: asc + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + requestBody: + $ref: '#/components/requestBodies/SearchContactsConditionsDetails' + responses: + '200': + $ref: '#/components/responses/SearchedContactsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: GetContactsBySearchContactsConditions + /transactional-emails/templates: + get: + tags: + - Transactional Emails Templates + summary: Get the list of transactional email templates + operationId: TransactionalEmailsTemplates_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search templates by subject + name: query[subject] + in: query + required: false + schema: + type: string + - description: Sort by creation date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by template subject + name: sort[subject] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailsTemplateList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + post: + tags: + - Transactional Emails Templates + summary: Create transactional email template + operationId: TransactionalEmailsTemplates_createNewTemplate + security: + - api-key: [] + - oauth2: + - all + description: This method creates a new transactional email template + requestBody: + $ref: '#/components/requestBodies/CreateTransactionalEmailTemplate' + responses: + '201': + $ref: '#/components/responses/TransactionalEmailsTemplateDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /transactional-emails: + get: + tags: + - Transactional Emails + summary: Get the list of transactional emails + operationId: TransactionalEmails_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search transactional emails sent from this date + name: query[sentOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search transactional emails sent to this date + name: query[sentOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search tagged/untagged transactional emails + name: query[tagged] + in: query + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - description: Search transactional emails with a specific tag ID + name: query[tagId] + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + post: + tags: + - Transactional Emails + summary: Send transactional email + operationId: TransactionalEmails_sendEmail + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/CreateTransactionalEmail' + responses: + '201': + $ref: '#/components/responses/TransactionalEmail' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /transactional-emails/statistics: + get: + tags: + - Transactional Emails + summary: Get the overall statistics of transactional emails + operationId: TransactionalEmails_getOverallStatistics + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: Group results by time interval + name: query[groupBy] + in: query + required: true + schema: + type: string + enum: + - total + - day + - description: Count data from this date + name: query[timeFrame][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Count data to this date + name: query[timeFrame][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search tagged/untagged transactional emails + name: query[tagged] + in: query + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - description: Search transactional emails with a specific tag ID + name: query[tagId] + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailStatistics' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /from-fields: + get: + tags: + - From Fields + summary: Get the list of 'From' addresses + operationId: FromFields_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search 'From' address by email + name: query[email] + in: query + required: false + schema: + type: string + - description: Search 'From' address by name + name: query[name] + in: query + required: false + schema: + type: string + format: date + - description: Search only default 'From' address + name: query[isDefault] + in: query + required: false + schema: + type: boolean + example: true + - description: Search only active 'From' addresses + name: query[isActive] + in: query + required: false + schema: + type: boolean + example: true + - description: Sort 'From' address by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FromFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - From Fields + summary: Create 'From' address + operationId: FromFields_createNewAddress + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/NewFromField' + responses: + '201': + $ref: '#/components/responses/FromFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /rss-newsletters: + get: + tags: + - RSS Newsletters + summary: Get the list of RSS newsletters + operationId: RssNewsletters_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search RSS newsletters by subject + name: query[subject] + in: query + required: false + schema: + type: string + - description: Search RSS newsletters by status + name: query[status] + in: query + required: false + schema: + type: string + enum: + - enabled + - disabled + - description: Search RSS newsletters created from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search RSS newsletters created to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search RSS newsletters by campaign ID + name: query[campaignId] + in: query + required: false + schema: + type: string + - description: Sort by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/RssNewsletterList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - RSS Newsletters + summary: Create RSS newsletter + operationId: RssNewsletters_createNewsletter + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/NewRssNewsletter' + responses: + '201': + $ref: '#/components/responses/RssNewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /rss-newsletters/statistics: + get: + tags: + - RSS Newsletters + summary: The statistics for all RSS newsletters + operationId: RssNewsletters_getStatistics + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Group results by time interval + name: query[groupBy] + in: query + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - description: The list of RSS newsletter resource IDs (string separated with ',') + name: query[rssNewsletterId] + in: query + required: false + schema: + type: string + - description: The list of campaign resource IDs (string separated with ',') + name: query[campaignId] + in: query + required: false + schema: + type: string + - description: Count data from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Count data to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: GetRssNewslettersStatistics + /custom-events: + get: + tags: + - Custom Events + summary: Get a list of custom events + operationId: CustomEvents_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search custom events by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search custom events with or without attributes + name: query[hasAttributes] + in: query + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CustomEventsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Custom Events + summary: Create custom event + operationId: CustomEvents_createEvent + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/NewCustomEvent' + responses: + '201': + $ref: '#/components/responses/CustomEventDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /custom-events/trigger: + post: + tags: + - Custom Events + summary: Trigger a custom event + operationId: CustomEvents_triggerEvent + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/TriggerCustomEvent' + responses: + '201': + description: Empty response + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: TriggerCustomEvent + /forms: + get: + tags: + - Forms + summary: Get the list of forms. + operationId: Forms_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search forms by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search forms created from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search forms created to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: >- + Search forms assigned to this list (campaign). You can pass multiple + comma-separated values, eg. `Xd1P,sC7r` + name: query[campaignId] + in: query + required: false + schema: + type: string + - description: >- + Search by status. **Note:** `disabled` includes both `unpublished` + and `draft` and `enabled` equals `published` + name: query[status] + in: query + required: false + schema: + type: string + enum: + - enabled + - disabled + - published + - unpublished + - draft + - name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[visitors] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[uniqueVisitors] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subscribed] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subscriptionRate] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FormList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /landing-pages: + get: + tags: + - Legacy Landing Pages + summary: Get a list of landing pages + operationId: LegacyLandingPages_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search landing pages by domain + name: query[domain] + in: query + required: false + schema: + type: string + - description: Search landing pages by status + name: query[status] + in: query + required: false + schema: + $ref: '#/components/schemas/StatusEnum' + - description: Search landing pages by subdomain + name: query[subdomain] + in: query + required: false + schema: + type: string + - description: Search landing pages by metaTitle field + name: query[metaTitle] + in: query + required: false + schema: + type: string + - description: Search landing pages by user provided domain + name: query[userDomain] + in: query + required: false + schema: + type: string + - description: >- + Search landing pages by ID of the assigned campaign. Campaign ID + must be encoded! You can get the campaign list with encoded IDs by + calling the `/v3/campaigns` endpoint. You can search by multiple + comma separated values eg. `o5lx,34er`. + name: query[campaignId] + in: query + required: false + schema: + type: string + - description: Show landing pages created from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Show landing pages created to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Sort by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by domain + name: sort[domain] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by campaign + name: sort[campaignId] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by metaTitle + name: sort[metaTitle] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/LandingPageList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /imports: + get: + tags: + - Imports + summary: Get a list of imports. + operationId: Imports_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search imports by campaignId + name: query[campaignId] + in: query + required: false + schema: + type: string + - description: Search imports created from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search imports created to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Sort imports by creation date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort imports by finish date + name: sort[finishedOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort imports by campaign name + name: sort[campaignName] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort imports by uploaded contact count + name: sort[uploadedContacts] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort imports by updated contact count + name: sort[updatedContacts] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort imports by inserted contact count + name: sort[addedContacts] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort imports by invalid contact count + name: sort[invalidContacts] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: >- + Sort imports by status (uploaded, to_review, approved, finished, + rejected, canceled) + name: sort[status] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ImportList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Imports + summary: Schedule a new contact import + operationId: Imports_scheduleNewContactImport + security: + - api-key: [] + - oauth2: + - all + description: >- + This endpoint lets you schedule a contact import. That way, you can add + and update your contacts using a single API call. Since API imports are + asynchronous, you should check periodically for updates while your + original API request is being processed. To keep track of your import + status, use [GET + import](https://apireference.getresponse.com/#operation/getImportById) + (provide the importId from the response), or subscribe to an [import + finished](https://apidocs.getresponse.com/v3/payloads#contacts-import-finished) + webhook. For more information on imports, check our [API + Docs](https://apidocs.getresponse.com/v3/case-study/create-import) or + [Help + Center](https://www.getresponse.com/help/how-do-i-prepare-a-file-for-import.html) + requestBody: + $ref: '#/components/requestBodies/NewImport' + responses: + '201': + $ref: '#/components/responses/ImportDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /statistics/ecommerce/revenue: + get: + tags: + - Ecommerce + summary: Get the ecommerce revenue statistics + operationId: Ecommerce_getRevenueStatistics + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: Show statistics for orders from this date + name: query[orderDate][from] + in: query + required: false + schema: + type: string + format: date + - description: Show statistics for orders to this date + name: query[orderDate][to] + in: query + required: false + schema: + type: string + format: date + - description: >- + Search statistics by shop ID. You can get the shop ID by calling the + `/v3/shops` endpoint. You can search for multiple shops using + comma-separated values, for example, `pgIH, CNXF` + name: query[shopId] + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/RevenueStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /statistics/ecommerce/performance: + get: + tags: + - Ecommerce + summary: Get the ecommerce general performance statistics + operationId: Ecommerce_getPerformanceStatistics + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: Show statistics for orders from this date + name: query[orderDate][from] + in: query + required: false + schema: + type: string + format: date + - description: Show statistics for orders to this date + name: query[orderDate][to] + in: query + required: false + schema: + type: string + format: date + - description: >- + Search statistics by shop ID. You can get the shop ID by calling the + `/v3/shops` endpoint. You can search for multiple shops using + comma-separated values, for example, `pgIH, CNXF` + name: query[shopId] + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/GeneralPerformanceStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /predefined-fields: + get: + tags: + - Predefined Fields + summary: Get the predefined fields list + operationId: PredefinedFields_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: DESC + - description: Search by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search by campaign ID + name: query[campaignId] + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/PredefinedFieldsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Predefined Fields + summary: Create a predefined field + operationId: PredefinedFields_createField + security: + - api-key: [] + - oauth2: + - all + description: Makes it possible to create a new predefined field. + requestBody: + $ref: '#/components/requestBodies/NewPredefinedField' + responses: + '201': + $ref: '#/components/responses/PredefinedFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /suppressions: + get: + tags: + - Suppressions + summary: Get suppression lists + operationId: Suppressions_getSuppressionLists + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: Search suppressions by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search suppressions created from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search suppressions created to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by the createdOn date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SuppressionsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Suppressions + summary: Creates a new suppression list + operationId: Suppressions_createNewSuppressionList + security: + - api-key: [] + - oauth2: + - all + requestBody: + description: The suppression list to be added. + $ref: '#/components/requestBodies/NewSuppression' + responses: + '201': + $ref: '#/components/responses/SuppressionDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /subscription-confirmations/body/{languageCode}: + get: + tags: + - Subscription Confirmations + summary: Get collection of SUBSCRIPTION CONFIRMATIONS bodies + operationId: SubscriptionConfirmations_getCollectionOfBodies + security: + - api-key: [] + - oauth2: + - all + description: >+ + + Sending **GET** request to this url, returns collection of + **SUBSCRIPTION CONFIRMATIONS** bodies. + + + Language code used in url must be in ISO 639-1 Language Code Standard. + + parameters: + - $ref: '#/components/parameters/languageCode' + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SubscriptionConfirmationBodyList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /subscription-confirmations/subject/{languageCode}: + get: + tags: + - Subscription Confirmations + summary: Get collection of SUBSCRIPTION CONFIRMATIONS subjects + operationId: SubscriptionConfirmations_getSubjectCollection + security: + - api-key: [] + - oauth2: + - all + description: >+ + + Sending **GET** request to this url, returns collection of + **SUBSCRIPTION CONFIRMATIONS** subjects. + + + Language code used in url must be in ISO 639-1 Language Code Standard. + + parameters: + - $ref: '#/components/parameters/languageCode' + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SubscriptionConfirmationSubjectList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /shops: + get: + tags: + - Shops + summary: Get a list of shops + operationId: Shops_getListOfShops + security: + - api-key: [] + - oauth2: + - all + description: >- + + Sending a **GET** request to this URL returns a collection of shop + resources. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + + The `name` fields can be a pattern and we'll try to match this phrase. + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + parameters: + - description: Search shop by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ShopList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Shops + summary: Create shop + operationId: Shops_createNewShop + security: + - api-key: [] + - oauth2: + - all + description: |+ + + This method makes it possible to create a new shop. + + requestBody: + $ref: '#/components/requestBodies/NewShop' + responses: + '201': + $ref: '#/components/responses/ShopDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /popups: + get: + tags: + - Forms and Popups + summary: Get the list of forms and popups + operationId: FormsAndPopups_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search forms and popups by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search forms and popups by status + name: query[status] + in: query + required: false + schema: + type: string + enum: + - published + - unpublished + - description: Show statistics from this date + name: stats[from] + in: query + required: false + schema: + type: string + format: date-time + - description: Show statistics to this date + name: stats[to] + in: query + required: false + schema: + type: string + format: date-time + - description: Sort forms and popups by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort forms and popups by status + name: sort[status] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort forms and popups by creation date + name: sort[createdAt] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort forms and popups by modification date + name: sort[updatedAt] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by number of views + name: sort[views] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by number of unique visitors + name: sort[uniqueVisitors] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by number of leads + name: sort[leads] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by CTR (click-through rate) + name: sort[ctr] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/PopupsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /splittests: + get: + tags: + - A/B tests + summary: The list of A/B tests. + operationId: AbTests_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + The list of A/B tests. You can filter the resource using criteria + specified as `query[*]`. You can provide multiple criteria, to use AND + logic. You can sort the resource using parameters specified as + `sort[*]`. You can specify multiple fields to sort by. + parameters: + - description: Search A/B tests by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search A/B tests by type + name: query[type] + in: query + required: false + schema: + type: string + - description: Search A/B tests by status + name: query[status] + in: query + required: false + schema: + type: string + default: active + enum: + - active + - inactive + - description: Search A/B tests created from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search A/B tests created to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by creation date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SplittestList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /file-library/quota: + get: + tags: + - File Library + summary: Get storage space information + operationId: FileLibrary_getStorageInfo + security: + - api-key: [] + - oauth2: + - all + responses: + '200': + $ref: '#/components/responses/Quota' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /file-library/files: + get: + tags: + - File Library + summary: Get the list of files + operationId: FileLibrary_getFileList + security: + - api-key: [] + - oauth2: + - all + description: >- + By default, you can only search files in the root directory. To search + for files in all folders, use the parameter `query[allFolders]=true`. To + search for files in a specified folder, use the parameter + `query[folderId]=`. **Note: these two parameters can't be used + together**. You can filter the resource using criteria specified as + `query[*]`. You can provide multiple criteria, to use AND logic. You can + sort the resource using parameters specified as `sort[*]`. You can + specify multiple fields to sort by. + parameters: + - description: >- + Return files from all folders, including the root folder. **This + parameter can't be used together with ** `query[folderId]` + name: query[allFolders] + in: query + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - description: >- + Search for files in a specific folder. **This parameter can't be + used together with ** `query[allFolders]` + name: query[folderId] + in: query + required: false + schema: + type: string + - description: Search for files by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search for files by group + name: query[group] + in: query + required: false + schema: + $ref: '#/components/schemas/FileGroup' + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort files by group + name: sort[group] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort files by size + name: sort[size] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FileList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - File Library + summary: Create a file + operationId: FileLibrary_createNewFile + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/NewFile' + responses: + '201': + $ref: '#/components/responses/File' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /file-library/folders: + get: + tags: + - File Library + summary: Get the list of folders + operationId: FileLibrary_listFolders + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search folders by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Sort folders by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort folders by size + name: sort[size] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort folders by creation date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FoldersList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - File Library + summary: Create a folder + operationId: FileLibrary_createFolder + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/NewFolder' + responses: + '201': + $ref: '#/components/responses/Folder' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /ab-tests/subject: + get: + tags: + - A/B tests - subject + summary: The list of A/B tests + operationId: AbTestsSubject_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search A/B tests by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search A/B tests by stage + name: query[stage] + in: query + required: false + schema: + type: string + enum: + - preparing + - testing + - finished + - sending-winner + - cancelled + - draft + - completed + - description: Search A/B tests by ID + name: query[abTestId] + in: query + required: false + schema: + type: string + - description: Search A/B tests by list ID + name: query[campaignId] + in: query + required: false + schema: + type: string + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by stage + name: sort[stage] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by send date + name: sort[sendOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by total delivered + name: sort[totalDelivered] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AbtestsSubjectGetList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - A/B tests - subject + summary: Create a new A/B test + operationId: AbTestsSubject_createNewTest + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/NewAbtestsSubject' + responses: + '201': + $ref: '#/components/responses/AbtestsSubjectGetDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /click-tracks: + get: + tags: + - Click Tracks + summary: Get click tracked links list + operationId: ClickTracks_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search click tracks from messages created from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search click tracks from messages created to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Sort by message date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ClickTrackList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /newsletters: + get: + tags: + - Newsletters + summary: Get the newsletter list + operationId: Newsletters_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search newsletters by subject + name: query[subject] + in: query + required: false + schema: + type: string + - description: Search newsletters by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search newsletters by status + name: query[status] + in: query + required: false + schema: + type: string + enum: + - enabled + - disabled + - description: Search newsletters created from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search newsletters created to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search for newsletters sent from this date + name: query[sendOn][from] + in: query + required: false + schema: + type: string + format: date + example: '2023-01-20' + - description: Search for newsletters sent to this date + name: query[sendOn][to] + in: query + required: false + schema: + type: string + format: date + example: '2023-01-20' + - description: Search newsletters by type + name: query[type] + in: query + required: false + schema: + type: string + enum: + - draft + - broadcast + - splittest + - automation + - description: Search newsletters by campaign ID + name: query[campaignId] + in: query + required: false + schema: + type: string + - description: Sort by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by send on date + name: sort[sendOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/NewsletterList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Newsletters + summary: Create newsletter + operationId: Newsletters_enqueueNewsletter + security: + - api-key: [] + - oauth2: + - all + description: | + > + This method creates a new newsletter and puts it in a queue to send. + + **NOTE: This method has a limit of 256 calls per day.** + requestBody: + $ref: '#/components/requestBodies/NewNewsletter' + responses: + '201': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /newsletters/send-draft: + post: + tags: + - Newsletters + summary: Send the newsletter draft + operationId: Newsletters_sendDraft + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/SendNewsletterDraft' + responses: + '201': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: SendNewsletterDraft + /newsletters/statistics: + get: + tags: + - Newsletters + summary: Total newsletter statistics + operationId: Newsletters_getStatisticsBasedOnList + security: + - api-key: [] + - oauth2: + - all + description: >- + >This makes it possible to fetch newsletter statistics based on the list + of campaign or newsletter IDs + + (you can pass them in the query parameter - see the description below). + Remember that all the statistics date ranges + + are returned in standard UTC period type objects. ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)). You + can filter the resource using criteria specified as `query[*]`. You can + provide multiple criteria, to use AND logic. You can sort the resource + using parameters specified as `sort[*]`. You can specify multiple fields + to sort by. + parameters: + - description: Group results by time interval + name: query[groupBy] + in: query + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - description: The list of newsletter resource IDs (string separated with '') + name: query[newsletterId] + in: query + required: false + schema: + type: string + - description: The list of campaign resource IDs (string separated with '') + name: query[campaignId] + in: query + required: false + schema: + type: string + - description: Count data from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Count data to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /tags: + get: + tags: + - Tags + summary: Get the list of tags + operationId: Tags_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search tags by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search tags created from this date + name: query[createdAt][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search tags created to this date + name: query[createdAt][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Sort tags by creation date + name: sort[createdAt] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TagList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Tags + summary: Add a new tag + operationId: Tags_addNewTag + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/NewTag' + responses: + '201': + $ref: '#/components/responses/TagDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /addresses: + get: + tags: + - Addresses + summary: Get a list of addresses + operationId: Addresses_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + + Sending a **GET** request to this URL returns collection of address + resources. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + + * firstName + + * lastName + + * address1 + + * address2 + + * city + + * zip + + * province + + * provinceCode + + * phone + + * company + + * createdOn + + + The `name` field can be a pattern and we'll try to match this phrase. + + + You can specify which page of the results you want and how many results + per page to display. You can also specify the sort-order using one or + more of the allowed fields (listed below in the request params section). + + + Last but not least, you can even specify which fields from a resource + you want to get. If you pass the param `fields` with the list of fields + (separated by a comma [,]) we'll return the list of resources with only + those fields (we'll always add a resource ID to ensure that you can use + that data later on) + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + parameters: + - description: Search addresses by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search addresses by first name + name: query[firstName] + in: query + required: false + schema: + type: string + - description: Search addresses by last name + name: query[lastName] + in: query + required: false + schema: + type: string + - description: Search addresses by address1 field + name: query[address1] + in: query + required: false + schema: + type: string + - description: Search addresses by address2 field + name: query[address2] + in: query + required: false + schema: + type: string + - description: Search addresses by city + name: query[city] + in: query + required: false + schema: + type: string + - description: Search addresses by ZIP + name: query[zip] + in: query + required: false + schema: + type: string + - description: Search addresses by province + name: query[province] + in: query + required: false + schema: + type: string + - description: Search addresses by province code + name: query[provinceCode] + in: query + required: false + schema: + type: string + - description: Search addresses by phone + name: query[phone] + in: query + required: false + schema: + type: string + - description: Search addresses by company + name: query[company] + in: query + required: false + schema: + type: string + - description: Search addresses created from this date + name: query[createdOn][from] + in: query + required: false + schema: + type: string + format: date-time + - description: Search addresses created to this date + name: query[createdOn][to] + in: query + required: false + schema: + type: string + format: date-time + - description: Sort by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AddressList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Addresses + summary: Create address + operationId: Addresses_createNewAddress + security: + - api-key: [] + - oauth2: + - all + description: '' + requestBody: + $ref: '#/components/requestBodies/NewAddress' + responses: + '201': + $ref: '#/components/responses/AddressDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /accounts/blocklists: + get: + tags: + - Accounts + summary: Returns account blocklist masks + operationId: Accounts_getBlocklistMasks + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: Blocklist mask to search for + name: query[mask] + in: query + required: false + schema: + type: string + example: '@somedomain.com' + responses: + '200': + $ref: '#/components/responses/AccountBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Accounts + summary: Update account blocklist + operationId: Accounts_updateBlocklist + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: >- + The flag value `add` adds the masks provided in the request body to + your blocklist. The flag value `delete` deletes the masks. The masks + are replaced if there are no flag values in the request body. + + For better performance, use the flag value `noResponse`. It removes the response body and can be used alone or combined with other flags. If multiple flags are used, separate them by a comma, like this: `additionalFlags=noResponse` or `additionalFlags=add,noResponse`. + name: additionalFlags + in: query + required: false + schema: + type: string + enum: + - add + - delete + - noResponse + requestBody: + $ref: '#/components/requestBodies/UpdateAccountBlocklist' + responses: + '200': + $ref: '#/components/responses/AccountBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-type: update + /custom-fields: + get: + tags: + - Custom Fields + summary: Get a list of custom fields + operationId: CustomFields_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search custom fields by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CustomFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Custom Fields + summary: Create a custom field + operationId: CustomFields_createNewField + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/NewCustomField' + responses: + '201': + $ref: '#/components/responses/CustomFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /lps: + get: + tags: + - Landing Pages + summary: Get the list of landing pages + operationId: LandingPages_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search landing pages by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search landing pages by status + name: query[status] + in: query + required: false + schema: + type: string + enum: + - published + - unpublished + - description: Show statistics for landing pages from this date + name: stats[from] + in: query + required: false + schema: + type: string + format: date-time + - description: Show statistics for landing pages to this date + name: stats[to] + in: query + required: false + schema: + type: string + format: date-time + - description: Sort landing pages by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort landing pages by creation date + name: sort[createdAt] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort landing pages by modification date + name: sort[updatedAt] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by number of page visits + name: sort[visits] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort landing pages by number of leads + name: sort[leads] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by subscription rate + name: sort[subscriptionRate] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/LpsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /multimedia: + get: + tags: + - Multimedia + summary: Get images list + operationId: Multimedia_getImageList + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ImageList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Multimedia + summary: Upload image + operationId: Multimedia_uploadImage + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/CreateMultimedia' + responses: + '200': + $ref: '#/components/responses/ImageDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: CreateMultimedia + x-type: upload + /tracking: + get: + tags: + - Tracking + summary: Get Tracking JavaScript code snippets + operationId: Tracking_javascriptCodeSnippets + security: + - api-key: [] + - oauth2: + - all + description: >- + With code snippets you will be able to track Purchases, Abandoned carts, + and Visited URLs. Find more in our [Help + Center](https://www.getresponse.com/help/marketing-automation/ecommerce-conditions/how-do-i-add-the-tracking-javascript-code-to-my-website.html). + responses: + '200': + $ref: '#/components/responses/Tracking' + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /tracking/facebook-pixels: + get: + tags: + - Tracking + summary: Get the list of "Facebook Pixels" + operationId: Tracking_getFacebookPixels + security: + - api-key: [] + - oauth2: + - all + description: >- + Returns the name and ID of "Facebook Pixels" assigned to a user's + account. + responses: + '200': + $ref: '#/components/responses/FacebookPixelList' + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /accounts: + get: + tags: + - Accounts + summary: Account information + operationId: Accounts_getInformation + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AccountDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Accounts + summary: Update account + operationId: Accounts_updateAccountDetails + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/UpdateAccount' + responses: + '200': + $ref: '#/components/responses/AccountDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: UpdateAccount + /accounts/billing: + get: + tags: + - Accounts + summary: Billing information + operationId: Accounts_getBillingInformation + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AccountBillingDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /accounts/login-history: + get: + tags: + - Accounts + summary: History of logins + operationId: Accounts_getLoginHistory + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AccountLoginHistoryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /accounts/badge: + get: + tags: + - Accounts + summary: Current status of your GetResponse badge + operationId: Accounts_getCurrentStatusOfBadge + security: + - api-key: [] + - oauth2: + - all + responses: + '200': + $ref: '#/components/responses/AccountBadgeDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Accounts + summary: Turn on/off the GetResponse Badge + operationId: Accounts_toggleBadgeStatus + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/UpdateAccountBadge' + responses: + '200': + $ref: '#/components/responses/AccountBadgeDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-type: update + /accounts/industries: + get: + tags: + - Accounts + summary: List of Industry Tags + operationId: Accounts_listIndustryTags + security: + - api-key: [] + - oauth2: + - all + description: List of Industry Tags in account's language context. + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/IndustryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /accounts/timezones: + get: + tags: + - Accounts + summary: List of timezones + operationId: Accounts_getTimezonesList + security: + - api-key: [] + - oauth2: + - all + description: List of timezones in account's language context. + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AccountTimezoneList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /accounts/callbacks: + get: + tags: + - Accounts + summary: Get callbacks configuration + operationId: Accounts_getConfiguration + security: + - api-key: [] + - oauth2: + - all + responses: + '200': + $ref: '#/components/responses/Callback' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Callbacks are disabled for the account + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Accounts + summary: Enable or update callbacks configuration + operationId: Accounts_enableCallbacksConfiguration + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/UpdateCallbacks' + responses: + '200': + $ref: '#/components/responses/Callback' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: UpdateCallback + delete: + tags: + - Accounts + summary: Disable callbacks + operationId: Accounts_disableCallbacks + security: + - api-key: [] + - oauth2: + - all + responses: + '204': + description: Empty response + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /accounts/sending-limits: + get: + tags: + - Accounts + summary: Send limits + operationId: Accounts_getSendingLimits + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SendingLimitsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /campaigns: + get: + tags: + - Campaigns (Lists) + summary: Get a list of campaigns + operationId: CampaignsLists_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - name: query[name] + in: query + required: false + schema: + type: string + example: campaign_name + - name: query[isDefault] + in: query + required: false + schema: + type: boolean + example: true + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CampaignList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Campaigns (Lists) + summary: Create a campaign + operationId: CampaignsLists_createNewCampaign + security: + - api-key: [] + - oauth2: + - all + requestBody: + $ref: '#/components/requestBodies/NewCampaign' + responses: + '201': + $ref: '#/components/responses/Campaign' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /campaigns/statistics/origins: + get: + tags: + - Campaigns (Lists) + summary: Get subscriber origin statistics + operationId: CampaignsLists_getSubscriberOriginStatistics + security: + - api-key: [] + - oauth2: + - all + description: The results are indexed with the campaign ID. + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/CampaignOriginsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: GetCampaignStatisticsOrigins + /campaigns/statistics/locations: + get: + tags: + - Campaigns (Lists) + summary: Get subscriber location statistics + operationId: CampaignsLists_getSubscriberLocationStatistics + security: + - api-key: [] + - oauth2: + - all + description: The results are indexed with the location name (PL, EN, etc.). + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/CampaignLocationsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: GetCampaignStatisticsLocations + /campaigns/statistics/list-size: + get: + tags: + - Campaigns (Lists) + summary: Get campaign size statistics + operationId: CampaignsLists_getCampaignSizeStatistics + security: + - api-key: [] + - oauth2: + - all + description: >- + Returns the number of the total added and removed subscribers, grouped + by default or by time period. + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/CampaignListSizesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: GetCampaignStatisticsListSize + /campaigns/statistics/subscriptions: + get: + tags: + - Campaigns (Lists) + summary: Get the number and origin of subscription statistics + operationId: CampaignsLists_getSubscriptionStatistics + security: + - api-key: [] + - oauth2: + - all + description: >- + Returns the number and origin of subscriptions, grouped by a specified + campaigns for each day on which any changes were made. Dates in the + YYYY-MM-DD format are used as keys in the response. + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/SubscriptionsByDatesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: GetCampaignStatisticsSubscriptions + /campaigns/statistics/removals: + get: + tags: + - Campaigns (Lists) + summary: Get removal statistics + operationId: CampaignsLists_getRemovalStatistics + security: + - api-key: [] + - oauth2: + - all + description: >- + Returns the number and reason for removed contacts. Dates in the + YYYY-MM-DD format are used as keys in the response. + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/RemovalsByDatesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: GetCampaignStatisticsRemovals + /campaigns/statistics/balance: + get: + tags: + - Campaigns (Lists) + summary: Get balance statistics + operationId: CampaignsLists_getBalanceStatistics + security: + - api-key: [] + - oauth2: + - all + description: >- + Returns the balance of subscriptions. Dates in the YYYY-MM-DD format are + used as keys in the response. + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/BalanceByDatesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: GetCampaignStatisticsBalance + /campaigns/statistics/summary: + get: + tags: + - Campaigns (Lists) + summary: Get the statistics summary for selected campaigns + operationId: CampaignsLists_getStatisticsSummary + security: + - api-key: [] + - oauth2: + - all + description: The results are indexed with the campaign ID. + parameters: + - name: query[campaignId] + in: query + required: false + schema: + $ref: '#/components/schemas/CampaignStatisticsIdQuery' + responses: + '200': + $ref: '#/components/responses/CampaignSummaryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: GetCampaignStatisticsSummary + /webforms: + get: + tags: + - Legacy Forms + summary: Get Legacy Forms. + operationId: LegacyForms_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + Get the list of Legacy Forms. You can filter the resource using criteria + specified as `query[*]`. You can provide multiple criteria, to use AND + logic. You can sort the resource using parameters specified as + `sort[*]`. You can specify multiple fields to sort by. + parameters: + - description: Search Legacy Forms by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search Legacy Forms modified from this date + name: query[modifiedOn][from] + in: query + required: false + schema: + type: string + format: date-time + - description: Search Legacy Forms modified to this date + name: query[modifiedOn][to] + in: query + required: false + schema: + type: string + format: date-time + - description: >- + Search Legacy Forms by campaignId. Accepts multiple IDs separated + with a comma + name: query[campaignId] + in: query + required: false + schema: + type: string + - description: Sort Legacy Forms by modification date + name: sort[modifiedOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/LegacyFormList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /gdpr-fields: + get: + tags: + - GDPR Fields + summary: Get the GDPR fields list + operationId: GdprFields_getList + security: + - api-key: [] + - oauth2: + - all + parameters: + - description: Sort fields by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort fields by creation date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/GDPRFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /workflow: + get: + tags: + - Workflows + summary: Get workflows + operationId: Workflows_listWorkflows + security: + - api-key: [] + - oauth2: + - all + description: Get the list of workflows. + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/WorkflowList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: GetWorkflows + /sms-automation: + get: + tags: + - SMS Automation Messages + summary: Get the list of automated SMS messages. + operationId: SmsAutomationMessages_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search automated SMS messages by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search automated SMS messages by campaign (list) ID + name: query[campaignId] + in: query + required: false + schema: + type: string + - description: Search for automated SMS messages containing links + name: query[hasLinks] + in: query + required: false + schema: + type: boolean + - description: Sort by the status of the SMS message + name: sort[status] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by the name of the automated SMS message + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by the date the SMS message was modified on + name: sort[modifiedOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by the number of delivered SMS messages + name: sort[delivered] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by the number of sent SMS messages + name: sort[sent] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by the number of link clicks + name: sort[clicks] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SmsAutomationList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /sms: + get: + tags: + - SMS Messages + summary: Get the list of SMS messages. + operationId: SmsMessages_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search SMS messages by type + name: query[type] + in: query + required: false + schema: + type: string + enum: + - sms + - draft + - description: Search SMS messages by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search SMS messages by status + name: query[sendingStatus] + in: query + required: false + schema: + type: string + enum: + - scheduled + - sending + - sent + - description: Search SMS messages by campaign (list) ID + name: query[campaignId] + in: query + required: false + schema: + type: string + - description: Search for SMS messages with links + name: query[hasLinks] + in: query + required: false + schema: + type: boolean + - description: Sort by sending status + name: sort[sendingStatus] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by sending date + name: sort[sendOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by modification date + name: sort[modifiedOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by number of delivered messages + name: sort[delivered] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by number of sent messages + name: sort[sent] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by number of link clicks + name: sort[clicks] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SmsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /autoresponders: + get: + tags: + - Autoresponders + summary: Get the list of autoresponders. + operationId: Autoresponders_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search autoresponder by subject + name: query[subject] + in: query + required: false + schema: + type: string + - description: Search autoresponder by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search autoresponder by status + name: query[status] + in: query + required: false + schema: + type: string + enum: + - enabled + - disabled + - description: Search autoresponder created from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search autoresponder created to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Search autoresponder by campaign ID + name: query[campaignId] + in: query + required: false + schema: + type: string + - description: Search autoresponder by type + name: query[type] + in: query + required: false + schema: + type: string + enum: + - timebase + - actionbase + - description: Search autoresponder by triggerType + name: query[triggerType] + in: query + required: false + schema: + type: string + enum: + - onday + - description: Sort by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by subject + name: sort[subject] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by cycle day + name: sort[dayOfCycle] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by delivered + name: sort[delivered] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by open rate + name: sort[openRate] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by click rate + name: sort[clickRate] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by date + name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AutoresponderList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + post: + tags: + - Autoresponders + summary: Create autoresponder + operationId: Autoresponders_createNewAutoresponder + security: + - api-key: [] + - oauth2: + - all + description: > + > + + **The action-based autoresponder feature has been migrated over to + marketing automation. Your existing autoresponders are + + now converted into workflows. You can no longer create and update + action-based autoresponders using our API.** + + + This request allows you to create an autoresponder. Remember to select + the proper `sendSettings` - depending on `type` you need to fill + corresponding setting (eg. if you selected type `delay`, then you MUST + fill `delayInHours` field). + requestBody: + $ref: '#/components/requestBodies/NewAutoresponder' + responses: + '201': + $ref: '#/components/responses/AutoresponderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + /autoresponders/statistics: + get: + tags: + - Autoresponders + summary: The statistics for all autoresponders + operationId: Autoresponders_getAllStatistics + security: + - api-key: [] + - oauth2: + - all + description: >- + > + + This returns the statistics summary for selected autoresponders. You can + select them by specifying the autoresponder or campaign IDs. + + As in all statistics, you can change the date and time range (hourly + daily monthly or total). Keep in mind + + that all statistics date ranges are given in standard UTC period type + objects. ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)) + + + (https://app.getresponse.com/statistics.html?t=followup#total). + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + parameters: + - description: Group results by time interval + name: query[groupBy] + in: query + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - description: The list of autoresponder resource IDs (string separated with '') + name: query[autoreponderId] + in: query + required: false + schema: + type: string + - description: The list of campaign resource IDs (string separated with '') + name: query[campaignId] + in: query + required: false + schema: + type: string + - description: Count data from this date + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - description: Count data to this date + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + x-operation-class-name: GetAutorespondersStatistics + /websites: + get: + tags: + - Websites + summary: Get the list of websites + operationId: Websites_getList + security: + - api-key: [] + - oauth2: + - all + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + parameters: + - description: Search websites by name + name: query[name] + in: query + required: false + schema: + type: string + - description: Search websites by status + name: query[status] + in: query + required: false + schema: + type: string + enum: + - published + - unpublished + - description: Show statistics for websites from this date + name: stats[from] + in: query + required: false + schema: + type: string + format: date-time + - description: Show statistics for websites to this date + name: stats[to] + in: query + required: false + schema: + type: string + format: date-time + - description: Sort websites by name + name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort websites by creation date + name: sort[createdAt] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort websites by modification date + name: sort[updatedAt] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort websites by page views + name: sort[pageViews] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by number of site visits + name: sort[visits] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - description: Sort by number of unique visitors + name: sort[uniqueVisitors] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/WebsitesList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f +components: + parameters: + webinarId: + description: The webinar ID + name: webinarId + in: path + required: true + schema: + type: string + example: yK6d + contactId: + description: The contact ID + name: contactId + in: path + required: true + schema: + type: string + example: pV3r + searchContactId: + description: The saved search contact identifier + name: searchContactId + in: path + required: true + schema: + type: string + example: pV3r + transactionalTemplateId: + description: Transactional emails template identifier + name: transactionalTemplateId + in: path + required: true + schema: + type: string + example: abc + transactionalEmailId: + name: transactionalEmailId + in: path + required: true + schema: + type: string + example: tRe4i + fromFieldId: + description: The 'From' address ID + name: fromFieldId + in: path + required: true + schema: + type: string + example: TTzW + rssNewsletterId: + description: The RSS newsletter ID + name: rssNewsletterId + in: path + required: true + schema: + type: string + example: dGer + taxId: + description: The tax ID + name: taxId + in: path + required: true + schema: + type: string + example: Sk + customEventId: + description: The custom event ID + name: customEventId + in: path + required: true + schema: + type: string + example: hp2 + formId: + description: The form ID + name: formId + in: path + required: true + schema: + type: string + example: pL4e + landingPageId: + description: The landing page ID. + name: landingPageId + in: path + required: true + schema: + type: string + example: avYn + importId: + description: The import ID + name: importId + in: path + required: true + schema: + type: string + example: o6gE + predefinedFieldId: + description: The predefined field identifier + name: predefinedFieldId + in: path + required: true + schema: + type: string + example: 6neM + categoryId: + description: The category ID + name: categoryId + in: path + required: true + schema: + type: string + example: C3s + suppressionId: + description: The suppression ID + name: suppressionId + in: path + required: true + schema: + type: string + example: pypF + orderId: + description: The order ID + name: orderId + in: path + required: true + schema: + type: string + example: fOh + languageCode: + description: ISO 639-1 Language Code Standard + name: languageCode + in: path + required: true + schema: + type: string + example: en + productId: + description: The product ID + name: productId + in: path + required: true + schema: + type: string + example: 9I + shopId: + description: The shop ID + name: shopId + in: path + required: true + schema: + type: string + example: pf3 + popupId: + description: The form or popup ID + name: popupId + in: path + required: true + schema: + type: string + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + splittestId: + description: The send settings for the A/B test + name: splittestId + in: path + required: true + schema: + type: string + example: 9I + cartId: + description: The cart ID + name: cartId + in: path + required: true + schema: + type: string + example: V + fileId: + description: The file ID + name: fileId + in: path + required: true + schema: + type: string + example: 6Yh + folderId: + description: The folder ID + name: folderId + in: path + required: true + schema: + type: string + example: Pa5 + abTestId: + description: A/B test ID + name: abTestId + in: path + required: true + schema: + type: string + example: xyz + clickTrackId: + name: clickTrackId + in: path + required: true + schema: + type: string + example: C12t + newsletterId: + description: The newsletter ID + name: newsletterId + in: path + required: true + schema: + type: string + example: 'N' + tagId: + description: The tag ID + name: tagId + in: path + required: true + schema: + type: string + example: vBd5 + addressId: + description: The address ID + name: addressId + in: path + required: true + schema: + type: string + example: k9 + customFieldId: + description: The custom field ID + name: customFieldId + in: path + required: true + schema: + type: string + example: pas + lpsId: + description: The landing page ID + name: lpsId + in: path + required: true + schema: + type: string + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + variantId: + description: The variant ID + name: variantId + in: path + required: true + schema: + type: string + example: VTB + campaignId: + description: The campaign ID + name: campaignId + in: path + required: true + schema: + type: string + example: 3Va2e + CampaignStatisticsIdQuery: + name: query[campaignId] + in: query + required: true + schema: + $ref: '#/components/schemas/CampaignStatisticsIdQuery' + CampaignStatisticsGroupByQuery: + name: query[groupBy] + in: query + required: false + schema: + type: string + enum: + - hour + - day + - month + - total + example: month + CampaignStatisticsDateFromQuery: + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + CampaignStatisticsDateToQuery: + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + metaFieldId: + description: The metafield ID + name: metaFieldId + in: path + required: true + schema: + type: string + example: hgF + webformId: + description: The webform (Legacy Form) ID + name: webformId + in: path + required: true + schema: + type: string + example: 3Va2e + gdprFieldId: + description: The GDPR field ID + name: gdprFieldId + in: path + required: true + schema: + type: string + example: MtY + workflowId: + description: The workflow ID + name: workflowId + in: path + required: true + schema: + type: string + example: 3Va2e + smsId: + description: The SMS message ID + name: smsId + in: path + required: true + schema: + type: string + example: 'N' + autoresponderId: + description: The autoresponder ID. + name: autoresponderId + in: path + required: true + schema: + type: string + example: Q + websiteId: + description: The website ID + name: websiteId + in: path + required: true + schema: + type: string + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + PerPage: + description: Requested number of results per page + name: perPage + in: query + required: false + schema: + type: integer + format: int32 + default: 100 + maximum: 1000 + minimum: 1 + Page: + description: Page number + name: page + in: query + required: false + schema: + type: integer + format: int32 + default: 1 + minimum: 1 + Fields: + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + name: fields + in: query + required: false + schema: + type: string + responses: + WebinarDetails: + description: The webinar details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Webinar' + WebinarList: + description: The list of webinars + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/WebinarsGetListResponse' + UpsertContactTags: + description: ' The list of contact tags.' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactsUpsertContactTagsResponse' + ContactActivityList: + description: The list of contact activities. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactsGetListOfActivitiesResponse' + ContactCustomFieldList: + description: The list of custom fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactCustomFieldList' + ContactList: + description: The list of contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactsGetSingleCampaignContactsResponse' + ContactDetails: + description: The contact details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactDetails' + BaseSearchContactsList: + description: The saved search contact. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/SearchContactsSavedListResponse' + SearchContactsDetails: + description: Search contact details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SearchContactsDetails' + SearchedContactsList: + description: The contact list. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/SearchContactsByIdResponse' + TransactionalEmailsTemplateDetails: + description: Transactional emails template details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionalEmailsTemplateDetails' + TransactionalEmailsTemplateList: + description: Transactional email templates listing + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionalEmailsTemplatesGetListResponse' + TransactionalEmailDetails: + description: Transactional email details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionalEmail' + TransactionalEmailStatistics: + description: The overall statistics of transactional emails + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: >- + #/components/schemas/TransactionalEmailsGetOverallStatisticsResponse + TransactionalEmailList: + description: The list of transactional emails + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionalEmailsGetListResponse' + TransactionalEmail: + description: Transactional email. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionalEmail' + FromFieldList: + description: The list of 'From' email addresses ('from fields'). + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/FromFieldsGetListResponse' + FromFieldDetails: + description: The 'From' address details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/FromField' + RssNewsletterDetails: + description: The RSS newsletter details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/RssNewsletter' + RssNewsletterList: + description: The list of RSS newsletters. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/RssNewslettersGetListResponse' + TaxDetails: + description: The tax details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Tax' + TaxList: + description: The list of taxes + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/TaxesGetListResponse' + CustomEventDetails: + description: The custom event details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEvent' + CustomEventsList: + description: The list of custom events + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEventsGetListResponse' + FormVariantList: + description: The list of form variants. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/FormsGetListOfVariantsResponse' + FormDetails: + description: The form details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/FormDetails' + FormList: + description: The list of forms. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/FormsGetListResponse' + LandingPageList: + description: The list of landing pages. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/LegacyLandingPagesGetListResponse' + LandingPageDetails: + description: The landing pages details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/LegacyLandingPagesGetByIdResponse' + ImportList: + description: The list of imports. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/ImportsGetListResponse' + ImportDetails: + description: The import details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Import' + SmsStats: + description: SMS statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsStats' + RevenueStats: + description: Revenue statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/RevenueStatistics' + GeneralPerformanceStats: + description: General performance statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/GeneralPerformanceStats' + PredefinedFieldsList: + description: The list of predefined fields. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/PredefinedFieldsGetListResponse' + PredefinedFieldDetails: + description: The predefined field details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/PredefinedField' + CategoryDetails: + description: The category details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Category' + CategoryList: + description: The list of categories + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/CategoriesListResponse' + SuppressionsList: + description: The suppressions list. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/SuppressionsGetSuppressionListsResponse' + SuppressionDetails: + description: The suppression details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SuppressionDetails' + OrderList: + description: The list of orders + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/OrdersGetListResponse' + OrderDetails: + description: The order details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + SubscriptionConfirmationBodyList: + description: List of subscription confirmation bodies + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: >- + #/components/schemas/SubscriptionConfirmationsGetCollectionOfBodiesResponse + SubscriptionConfirmationSubjectList: + description: List of subscription confirmation subjects + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: >- + #/components/schemas/SubscriptionConfirmationsGetSubjectCollectionResponse + ProductList: + description: The list of products + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/ProductsGetListResponse' + SimpleProductCategoryList: + description: The list of product categories + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ProductsUpsertCategoriesResponse' + ProductDetails: + description: The product details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndUpdate' + ShopList: + description: The list of shops + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/ShopsGetListOfShopsResponse' + ShopDetails: + description: The shop details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndUpdate' + PopupGeneralPerformance: + description: Form or popup statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/PopupGeneralPerformanceStats' + PopupDetails: + description: Form or popup details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/PopupDetails' + PopupsList: + description: The list of forms and popups + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/FormsAndPopupsGetListResponse' + SplittestList: + description: The list of A/B tests. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/AbTestsGetListResponse' + Splittest: + description: A/B test details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Splittest' + CartDetails: + description: The cart details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndUpdate' + CartList: + description: The list of carts + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/CartsGetShopCartsResponse' + Quota: + description: Storage space information + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Quota' + FileList: + description: The list of files + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/FileLibraryGetFileListResponse' + File: + description: The file details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/BaseFile' + Folder: + description: The folder details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/FileLibraryCreateFolderResponse' + FoldersList: + description: The list of folders + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/FileLibraryListFoldersResponse' + AbtestsSubjectGetDetails: + description: A/B test details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AbtestsSubjectDetails' + AbtestsSubjectGetList: + description: The list of A/B tests + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/AbTestsSubjectGetListResponse' + ClickTrack: + description: The click track details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ClickTrackResource' + ClickTrackList: + description: The list of click tracks + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/ClickTracksGetListResponse' + MessageStatisticsListElement: + description: The message statistics. + content: + application/json: + schema: + $ref: '#/components/schemas/MessageStatisticsListElement' + NewsletterDetails: + description: The newsletter details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Newsletter' + NewsletterList: + description: The list of newsletters. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/NewslettersGetListResponse' + NewsletterActivities: + description: The list of newsletters activities + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/NewslettersGetActivitiesResponse' + TagDetails: + description: The tag details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/BaseTag' + TagList: + description: The list of tags + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/TagsGetListResponse' + AddressList: + description: The list of addresses. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/AddressesGetListResponse' + AddressDetails: + description: The address details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndUpdate' + AccountBlocklist: + description: Blocklist masks for the whole account. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Blocklist' + CampaignBlocklist: + description: Blocklist masks for the campaign. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Blocklist' + CustomFieldDetails: + description: The custom field details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CustomField' + CustomFieldList: + description: The list of custom fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/CustomFieldsGetListResponse' + LpsList: + description: The list of tags + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/LandingPagesGetListResponse' + LpsDetails: + description: The landing page details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/LpsDetails' + LpsStats: + description: Landing page statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/LpsStats' + ImageList: + description: Image list + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/MultimediaGetImageListResponse' + ImageDetails: + description: Image details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ImageDetails' + Tracking: + description: The Tracking Snippets + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TrackingJavascriptCodeSnippetsResponse' + FacebookPixelList: + description: '"Facebook Pixel" details' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TrackingGetFacebookPixelsResponse' + ProductVariantDetails: + description: The product variant details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ProductVariant' + ProductVariantList: + description: The list of product variants + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/ProductVariantsGetProductVariantsListResponse' + AccountBadgeDetails: + description: Account badge status + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AccountBadgeDetails' + SendingLimitsList: + description: Send limits + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AccountsGetSendingLimitsResponse' + IndustryList: + description: Industry tags list + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/AccountsListIndustryTagsResponse' + AccountTimezoneList: + description: List of time zones + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AccountsGetTimezonesListResponse' + AccountLoginHistoryList: + description: Login history information + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/AccountsGetLoginHistoryResponse' + Callback: + description: Callback configuration + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Callback' + AccountDetails: + description: Your account information + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Account' + AccountBillingDetails: + description: Billing information. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AccountBilling' + SubscriptionsByDatesStatisticsList: + description: Subscription statistics by date + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionsByDatesStatisticsList' + CampaignSummaryList: + description: The summary list. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignSummaryList' + CampaignLocationsList: + description: The list of locations. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignLocationsList' + RemovalsByDatesStatisticsList: + description: Subscription statistics by date + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/RemovalsByDatesStatisticsList' + CampaignOriginsList: + description: The list of origins. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignOriginsList' + CampaignListSizesStatisticsList: + description: The campaign data. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignListSizesStatisticsList' + BalanceByDatesStatisticsList: + description: The subscription statistics, shown by date. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/BalanceByDatesStatisticsList' + Campaign: + description: The campaign data. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Campaign' + CampaignList: + description: The list of campaigns. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignsListsGetListResponse' + MetaFieldDetails: + description: The meta field details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/MetaField' + MetaFieldList: + description: The list of meta fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/ProductsUpsertMetaFieldsResponse' + LegacyForm: + description: The Legacy Form. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/LegacyForm' + LegacyFormList: + description: The list of Legacy Forms. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/LegacyFormsGetListResponse' + GDPRFieldList: + description: The list of GDPR fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/GdprFieldsGetListResponse' + GDPRFieldDetails: + description: The details of the GDPR field + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/GDPRFieldDetails' + Workflow: + description: The workflow + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Workflow' + WorkflowList: + description: The list of workflows + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/WorkflowsListWorkflowsResponse' + SmsDetails: + description: The SMS message details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsListItem' + SmsAutomationList: + description: The list of the automated SMS messages + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsAutomationListItem' + SmsList: + description: The SMS message listing + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsListItem' + MessageStatisticsList: + description: The list of autoresponders statistic split by time interval. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/RssNewslettersGetStatisticsResponse' + SingleMessageStatisticsList: + description: The list of autoresponder statistics split by time interval. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/RssNewslettersGetStatisticsByIdResponse' + AutoresponderDetails: + description: The autoresponder details' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Autoresponder' + AutoresponderList: + description: The list of autoresponders. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/AutoresponderList' + WebsitesList: + description: The list of tags + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/WebsitesGetListResponse' + WebsiteStats: + description: Website statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/WebsiteStats' + WebsiteDetails: + description: The website details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/WebsiteDetails' + schemas: + CreateAndUpdate: + properties: + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + updatedOn: + description: The date of the last update + type: string + format: date-time + readOnly: true + type: object + BaseCategory: + properties: + categoryId: + description: The category ID + type: string + readOnly: true + example: atQ + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/categories/atQ + name: + description: The name of the category + type: string + maxLength: 64 + minLength: 2 + example: Headwear + parentId: + description: The parent category ID + type: string + maxLength: 64 + minLength: 2 + example: amh + isDefault: + description: This is a default category + type: boolean + example: true + url: + description: The external URL to the category + type: string + format: uri + maxLength: 2048 + example: https://somedomain.com/category/446 + externalId: + description: >- + The external ID is the identifying string or number of the category + given by another software + type: string + maxLength: 255 + example: ext3343 + type: object + Category: + type: object + allOf: + - $ref: '#/components/schemas/BaseCategory' + - $ref: '#/components/schemas/CreateAndUpdate' + ProductCategory: + type: object + allOf: + - $ref: '#/components/schemas/BaseCategory' + - $ref: '#/components/schemas/CreateAndUpdate' + BaseMetaField: + properties: + description: + description: The meta field description + type: string + maxLength: 255 + minLength: 0 + example: Description of this meta field + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/meta-fields/NoF + metaFieldId: + description: The meta field ID + type: string + readOnly: true + example: NoF + name: + description: The meta field name + type: string + maxLength: 63 + minLength: 3 + example: Shoe size + value: + description: The meta field value + type: string + maxLength: 65000 + minLength: 0 + example: '11' + valueType: + description: The value type enumerable + type: string + enum: + - string + - integer + example: integer + type: object + MetaField: + type: object + allOf: + - $ref: '#/components/schemas/BaseMetaField' + - $ref: '#/components/schemas/CreateAndUpdate' + UpsertProductCategory: + description: >- + This method makes it possible to assign product categories, and to set a + default product category. It doesn't remove or unassign product + categories. + required: + - categories + properties: + categories: + type: array + items: + $ref: '#/components/schemas/UpsertSingleProductCategory' + type: object + UpsertSingleProductCategory: + required: + - categoryId + properties: + categoryId: + description: The category ID + type: string + example: atQ + isDefault: + description: This is a default category + type: boolean + example: true + type: object + UpsertMetaField: + description: This method assigns metafields. It doesn't unassign or delete them. + required: + - metaFields + properties: + metaFields: + type: array + items: + $ref: '#/components/schemas/UpsertSingleMetaField' + type: object + UpsertSingleMetaField: + required: + - metaFieldId + properties: + metaFieldId: + description: MetaField ID + type: string + example: NoF + type: object + BaseProductVariant: + properties: + description: + description: The description of a variant + type: string + maxLength: 1000 + minLength: 2 + example: Red Cap with GetResponse Monster print + variantId: + description: The product ID + type: string + readOnly: true + example: VTB + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/products/9I/variants/VTB + name: + description: The product name + type: string + maxLength: 255 + minLength: 1 + example: Red Monster Cap + url: + description: The external URL to the product variant + type: string + format: uri + maxLength: 2048 + example: https://somedomain.com/products-variants/986 + sku: + description: >- + The stock-keeping unit of a variant. Must be unique within the + product + type: string + maxLength: 255 + minLength: 2 + example: SKU-1254-56-457-5689 + price: + description: The price + type: number + format: double + example: 20 + priceTax: + description: The price including tax + type: number + format: double + example: 27.5 + previousPrice: + description: The price before the change + type: number + format: double + example: 25 + nullable: true + previousPriceTax: + description: The price before the change including tax + type: number + format: double + example: 33.6 + nullable: true + quantity: + description: The quantity of variant items + type: integer + format: int64 + default: 1 + position: + description: The position of a variant + type: integer + format: int64 + example: 1 + barcode: + description: The barcode of a variant + type: string + maxLength: 255 + minLength: 2 + example: '12455687' + externalId: + description: >- + The external ID is the identifying string or number of the variant + given by another software + type: string + maxLength: 255 + example: ext1456 + images: + type: array + items: + $ref: '#/components/schemas/NewProductVariantImage' + metaFields: + type: array + items: + $ref: '#/components/schemas/BaseMetaField' + taxes: + type: array + items: + $ref: '#/components/schemas/BaseTax' + type: object + ProductVariant: + type: object + allOf: + - $ref: '#/components/schemas/BaseProductVariant' + - $ref: '#/components/schemas/CreateAndUpdate' + NewProductVariantImage: + required: + - src + - position + properties: + imageId: + description: The image ID + type: string + readOnly: true + example: hY + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/images/hY + src: + description: The source URL of an image + type: string + format: uri + example: http://somedomain.com/images/src/img58db7ec64bab9.png + position: + description: The position of an image + type: integer + format: int32 + example: 1 + type: object + BaseTax: + properties: + taxId: + description: The tax ID + type: string + readOnly: true + example: Sk + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/taxes/Sk + name: + description: The tax name + type: string + maxLength: 255 + minLength: 2 + example: VAT + rate: + description: The rate value + type: number + format: double + maximum: 99.9 + minimum: 0 + example: 23 + type: object + Tax: + type: object + allOf: + - $ref: '#/components/schemas/BaseTax' + - $ref: '#/components/schemas/CreateAndUpdate' + Order: + properties: + description: + description: The order description + type: string + example: More information about order. + orderId: + description: The order ID + type: string + readOnly: true + example: fOh + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/orders/fOh + contactId: + description: >- + Create a contact by using `POST /v3/contacts`. Or, if the contact + already exists, using `GET /v3/contacts` + type: string + example: k8u + orderUrl: + description: The external URL for an order + type: string + format: uri + maxLength: 2048 + example: https://somedomain.com/orders/order446 + externalId: + description: >- + The external ID is the identifying string or number of the order + given by another software + type: string + maxLength: 255 + example: DH71239 + totalPrice: + description: The total price of an order + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 716 + totalPriceTax: + description: The total price tax of an order + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 358.67 + currency: + description: The order currency code (ISO 4217) + type: string + example: PLN + status: + description: The status value + type: string + maxLength: 64 + example: NEW + cartId: + description: Create a cart by using `POST /v3/shops/{shopId}/carts` + type: string + example: QBNgBR + shippingPrice: + description: The shipping price for an order + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 23 + shippingAddress: + $ref: '#/components/schemas/CreateAndUpdate' + billingStatus: + description: The billing status of an order + type: string + example: PENDING + billingAddress: + $ref: '#/components/schemas/CreateAndUpdate' + processedAt: + description: The exact time an order was made + type: string + format: date-time + metaFields: + type: array + items: + $ref: '#/components/schemas/BaseMetaField' + type: object + x-konfig-properties: + shippingAddress: + description: The shipping address for an order + billingAddress: + description: The billing address for an order + NewSelectedProductVariant: + required: + - variantId + - price + - quantity + properties: + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/aS/products/Rf/variants/aBc + variantId: + description: >- + The ID of a selected variant. You must first create a variant + using: + + + `POST` [Create + product](https://apireference.getresponse.com/#operation/createProduct) + + + `POST` [Create product + variant](https://apireference.getresponse.com/#operation/createProductVariant) + + or get ID from variants created already: + + `GET` [Get a list of product variants](https://apireference.getresponse.com/#operation/getProductVariantList) + type: string + example: p + price: + description: The product variant price + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 840 + priceTax: + description: The product variant price tax + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 428 + quantity: + description: The product variant quantity + type: integer + format: int32 + minimum: 1 + example: 2 + taxes: + type: array + items: + $ref: '#/components/schemas/BaseTax' + type: object + NewCartSelectedProductVariant: + required: + - variantId + - quantity + - price + - priceTax + properties: + variantId: + description: >- + The ID of a selected variant. You must first create a variant + using: + + + `POST` [Create + product](https://apireference.getresponse.com/#operation/createProduct) + + + `POST` [Create product + variant](https://apireference.getresponse.com/#operation/createProductVariant) + + or get ID from variants created already: + + `GET` [Get a list of product variants](https://apireference.getresponse.com/#operation/getProductVariantList) + type: string + example: VTB + quantity: + description: The quantity + type: integer + format: int64 + minimum: 1 + example: 3 + price: + description: The price, tax excluded + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 57 + priceTax: + description: The price, tax included + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 68 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/products/9I/variants/VTB + type: object + Webinar: + properties: + webinarId: + type: string + readOnly: true + example: yK6d + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/webinars/yK6d + createdOn: + type: string + format: date-time + readOnly: true + startsOn: + type: string + format: date-time + webinarUrl: + description: The URL to the webinar room + type: string + format: uri + status: + type: string + enum: + - upcoming + - finished + - published + - unpublished + readOnly: true + type: + description: The webinar type + type: string + enum: + - all + - live + - on_demand + readOnly: true + campaigns: + type: array + items: + $ref: '#/components/schemas/CampaignReference' + newsletters: + description: The list of invitation messages + type: array + items: + $ref: '#/components/schemas/WebinarNewsletter' + statistics: + type: object + $ref: '#/components/schemas/WebinarStatistics' + type: object + WebinarStatistics: + required: + - registrants + - visitors + - attendees + properties: + registrants: + type: integer + format: int64 + example: 15 + visitors: + type: integer + format: int64 + example: 10 + attendees: + type: integer + format: int64 + example: 5 + type: object + WebinarNewsletter: + required: + - newsletterId + - href + properties: + newsletterId: + description: The ID of the webinar invitation message + type: string + example: NuE4 + href: + description: Direct hyperlink to a resource + type: string + example: https://api.getresponse.com/v3/newsletters/NuE4 + type: object + ContactCustomField: + properties: + customFieldId: + type: string + example: kL6Nh + values: + type: array + items: + type: string + example: 18-35 + type: object + ContactActivity: + properties: + activity: + description: The type of activity + type: string + enum: + - send + - open + - click + example: click + subject: + type: string + example: Shop offer update! + createdOn: + description: The activity date + type: string + format: date-time + previewUrl: + description: >- + This is only available for the `send` activity. It includes a link + to the message preview + type: string + format: uri + example: >- + https://www.grnewsletters.com/archive/campaign_name55f6b0ff01/Test-2135303.html + nullable: true + resource: + type: object + $ref: '#/components/schemas/ContactActivityResource' + clickTrack: + description: >- + This is only available for the `click` activity. It includes the + clicked link data + type: object + nullable: true + $ref: '#/components/schemas/ContactActivityClickTrack' + type: object + readOnly: true + ContactActivityClickTrack: + properties: + id: + description: The click tracking ID + type: string + example: 62WrE + name: + description: The name of the clicked link + type: string + example: Go to shop + url: + description: The URL of the clicked link + type: string + format: uri + example: https://my-shop.example.com/ + type: object + ContactActivityResource: + properties: + resourceId: + type: string + example: oY2n + nullable: true + resourceType: + type: string + enum: + - newsletters + - splittests + - autoresponders + - rss-newsletters + - sms + example: newsletters + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/newsletters/oY2n + type: object + ContactCustomFieldList: + type: array + items: + $ref: '#/components/schemas/ContactCustomField' + ContactListElement: + allOf: + - $ref: '#/components/schemas/Contact' + - properties: + note: + type: string + maxLength: 255 + minLength: 0 + nullable: true + ipAddress: + description: The contact's IP address. IPv4 and IPv6 formats are accepted. + example: 1.2.3.4 + oneOf: + - type: string + format: ipv4 + - type: string + format: ipv6 + type: object + ContactDetails: + type: object + allOf: + - $ref: '#/components/schemas/ContactListElement' + - properties: + tags: + description: The list of contact tags, limited to 500 tags. + type: array + items: + $ref: '#/components/schemas/ContactTag' + geolocation: + type: object + readOnly: true + $ref: '#/components/schemas/ContactGeolocation' + customFieldValues: + type: array + items: + $ref: '#/components/schemas/ContactCustomFieldValue' + type: object + ContactCustomFieldValue: + required: + - customFieldId + - name + - type + - value + - values + properties: + customFieldId: + description: Custom field ID + type: string + example: 4klkN + name: + type: string + example: age + value: + type: array + items: + type: string + example: 18-35 + values: + type: array + items: + type: string + example: 18-35 + type: + type: string + example: single_select + fieldType: + type: string + example: single_select + valueType: + type: string + example: string + type: object + ContactGeolocation: + properties: + latitude: + type: string + example: '54.35' + nullable: true + longitude: + type: string + example: '18.6667' + nullable: true + continentCode: + type: string + enum: + - OC + - AN + - SA + - NA + - AS + - EU + - AF + example: EU + nullable: true + countryCode: + description: The country code, compliant with ISO 3166-1 alpha-2 + type: string + example: PL + nullable: true + region: + type: string + example: '82' + nullable: true + postalCode: + type: string + example: 80-387 + nullable: true + dmaCode: + type: string + nullable: true + city: + type: string + example: Gdansk + nullable: true + type: object + BaseSearchContacts: + description: The short description of a saved search. + properties: + searchContactId: + description: The unique search-contact identifier + type: string + readOnly: true + example: pV3r + name: + description: The unique name of search-contact + type: string + example: custom test filter + createdOn: + description: The UTC date time format ISO 8601, e.g. 2018-04-10T10:02:57+0000 + type: string + format: date-time + readOnly: true + example: 2018-04-10T10:02:57+0000 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://app.getresponse.com/v3/search-contacts/pV3r + type: object + SearchContactsDetails: + description: Search contact details. + required: + - searchContactId + - name + - createdOn + - href + type: object + allOf: + - $ref: '#/components/schemas/SearchContactsConditionsDetails' + - $ref: '#/components/schemas/BaseSearchContacts' + SearchContactsConditionsDetails: + required: + - subscribersType + - sectionLogicOperator + - section + properties: + subscribersType: + description: Only one subscription status + type: array + items: + type: string + enum: + - subscribed + - undelivered + - removed + - unconfirmed + example: + - subscribed + sectionLogicOperator: + description: >- + Match 'any' (`or` value) or 'all' (`and` value) of the following + conditions + type: string + enum: + - or + - and + example: or + section: + type: array + items: + $ref: '#/components/schemas/SearchContactSection' + type: object + example: + subscribersType: + - subscribed + sectionLogicOperator: or + section: + - campaignIdsList: + - tamqY + logicOperator: or + subscriberCycle: + - receiving_autoresponder + - not_receiving_autoresponder + subscriptionDate: all_time + conditions: + - conditionType: crm + pipelineScope: PSVq + stageScope: all + NewSearchContacts: + description: New search contacts. + required: + - name + - subscribersType + - sectionLogicOperator + - section + type: object + allOf: + - $ref: '#/components/schemas/SearchContactsConditionsDetails' + - $ref: '#/components/schemas/BaseSearchContacts' + UpdateSearchContacts: + description: New search contacts. + required: + - name + - subscribersType + - sectionLogicOperator + - section + type: object + allOf: + - $ref: '#/components/schemas/SearchContactsConditionsDetails' + - $ref: '#/components/schemas/BaseSearchContacts' + SpecificDateEnum: + description: The specific date. + type: string + enum: + - today + - yesterday + - last_7_days + - last_30_days + - last_n_days + - this_week + - last_week + - this_month + - last_month + example: last_30_days + SpecificDateExtendedEnum: + description: The specific date. + type: string + example: last_30_days + oneOf: + - $ref: '#/components/schemas/SpecificDateEnum' + - description: The last 2 months specific date constant. + enum: + - last_2_months + type: string + RelationalNumericOperatorEnum: + description: The relational operators. + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_lt + MessageTypeOperator: + description: The type of message. + type: string + enum: + - autoresponder + - newsletter + - splittest + - automation + example: autoresponder + SearchedContactDetails: + properties: + contactId: + description: The contact identifier + type: string + example: jtLF5i + name: + description: The contact description + type: string + example: John Doe + nullable: true + email: + type: string + format: email + example: john.doe@example.com + origin: + type: string + enum: + - import + - email + - www + - panel + - leads + - sale + - api + - forward + - survey + - iphone + - copy + - landing_page + - webinar + example: landing_page + dayOfCycle: + type: string + format: integer + example: '153' + nullable: true + createdOn: + type: string + format: date-time + example: 2018-01-15T13:30:42+0000 + campaign: + type: object + example: + campaignId: tamqY + name: test_campaign + href: https://api.getresponse.com/v3/campaigns/tamqY + $ref: '#/components/schemas/CampaignReference' + score: + type: string + format: integer + example: '5' + nullable: true + reason: + type: string + enum: + - api + - automation + - blacklisted + - bounce + - cleaner + - complaint + - support + - unsubscribe + - user + example: support + nullable: true + deletedOn: + type: string + format: date-time + example: 2024-02-12T11:00:00+0000 + nullable: true + type: object + readOnly: true + SpecificDateType: + description: The date formatted as yyyy-mm-dd + type: string + format: date + example: '2018-04-01' + SpecificDateTimeType: + description: The date time string compliant with ISO 8601 + type: string + format: date + example: 2018-04-01T00:00:00+0000 + IntervalDateType: + description: >- + The date interval string compliant with ISO 8601, supported format: + / + type: string + example: 2018-04-01/2018-04-10 + ConditionStringOperator: + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - string_operator + example: string_operator + operator: + type: string + enum: + - is + - is_not + - contains + - not_contains + - starts + - ends + - not_starts + - not_ends + example: is_not + value: + type: string + example: new + type: object + example: + operatorType: string_operator + operator: starts + value: new + ConditionStringOperatorList: + description: Used with a custom field only. + required: + - operatorType + - operator + properties: + operatorType: + type: string + enum: + - string_operator_list + example: string_operator_list + operator: + type: string + enum: + - is + - is_not + - contains + - not_contains + - starts + - ends + - not_starts + - not_ends + - assigned + - not_assigned + example: is + value: + description: The value of the search + type: string + example: 18-29 + type: object + example: + operatorType: string_operator_list + operator: is + value: 18-29 + ConditionMessageOperator: + description: The operator allows searching by message type. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - message_operator + example: message_operator + operator: + $ref: '#/components/schemas/MessageTypeOperator' + value: + description: >- + The identifier of a selected resource: autoresponder, newsletter, + split test or automation message + type: string + example: SGNLr + type: object + example: + operatorType: message_operator + operator: autoresponder + value: SGNLr + CustomDateRange: + required: + - from + - to + properties: + from: + description: The UTC date format + type: string + format: date + example: '2018-04-01' + to: + description: The UTC date format + type: string + format: date + example: '2018-04-10' + type: object + SearchContactSection: + required: + - campaignIdsList + - logicOperator + - subscriberCycle + - subscriptionDate + properties: + campaignIdsList: + description: An array of campaign identifiers + type: array + items: + type: string + example: tamqY + example: + - tamqY + - tuKd3 + logicOperator: + type: string + enum: + - and + - or + subscriberCycle: + description: Defining whether or not a subscriber is in an autoresponder cycle + type: array + items: + type: string + enum: + - receiving_autoresponder + - not_receiving_autoresponder + example: + - receiving_autoresponder + - not_receiving_autoresponder + conditions: + description: One of the search contact conditions + type: array + items: + $ref: '#/components/schemas/ConditionType' + subscriptionDate: + description: Matches the matching period + type: string + enum: + - all_time + - today + - yesterday + - last_7_days + - last_30_days + - this_week + - last_week + - this_month + - last_month + - last_2_months + - custom + type: object + discriminator: + propertyName: subscriptionDate + mapping: + all_time: '#/components/schemas/SectionAllTimeSubscriptionDate' + today: '#/components/schemas/SectionTodaySubscriptionDate' + yesterday: '#/components/schemas/SectionYesterdaySubscriptionDate' + last_7_days: '#/components/schemas/SectionLast7DaysSubscriptionDate' + last_30_days: '#/components/schemas/SectionLast30DaysSubscriptionDate' + this_week: '#/components/schemas/SectionThisWeekSubscriptionDate' + last_week: '#/components/schemas/SectionLastWeekSubscriptionDate' + this_month: '#/components/schemas/SectionThisMonthSubscriptionDate' + last_month: '#/components/schemas/SectionLastMonthSubscriptionDate' + last_2_months: '#/components/schemas/SectionLast2MonthsSubscriptionDate' + custom: '#/components/schemas/SectionCustomSubscriptionDate' + ConditionType: + required: + - conditionType + properties: + conditionType: + type: string + enum: + - name + - email + - custom + - subscription_date + - subscription_method + - opened + - not_opened + - phase + - last_send_date + - last_click_date + - last_open_date + - webinar + - clicked + - not_clicked + - sent + - not_sent + - geo + - scoring + - engagement_score + - tag + - goal + - crm + - ecommerce_number_of_purchases + - ecommerce_total_spent + - ecommerce_product_purchased + - ecommerce_brand_purchased + - ecommerce_abandoned_cart + - sms_sent + - sms_delivered + - sms_link_clicked + - sms_link_not_clicked + - custom_event + type: object + discriminator: + propertyName: conditionType + mapping: + name: '#/components/schemas/NameCondition' + email: '#/components/schemas/EmailCondition' + custom: '#/components/schemas/CustomFieldCondition' + subscription_date: '#/components/schemas/SubscriptionDateCondition' + subscription_method: '#/components/schemas/SubscriptionMethodCondition' + opened: '#/components/schemas/OpenedCondition' + not_opened: '#/components/schemas/NotOpenedCondition' + phase: '#/components/schemas/AutoresponderDayCondition' + last_send_date: '#/components/schemas/LastSendDateCondition' + last_click_date: '#/components/schemas/LastClickDateCondition' + last_open_date: '#/components/schemas/LastOpenDateCondition' + webinar: '#/components/schemas/WebinarCondition' + clicked: '#/components/schemas/LinkClickedCondition' + not_clicked: '#/components/schemas/LinkNotClickedCondition' + sent: '#/components/schemas/MessageSentCondition' + not_sent: '#/components/schemas/MessageNotSentCondition' + geo: '#/components/schemas/GeolocationCondition' + scoring: '#/components/schemas/ScoringCondition' + engagement_score: '#/components/schemas/EngagementScoreCondition' + tag: '#/components/schemas/TagCondition' + goal: '#/components/schemas/GoalCondition' + crm: '#/components/schemas/CrmCondition' + ecommerce_number_of_purchases: '#/components/schemas/ECommerceNumberOfPurchasesCondition' + ecommerce_total_spent: '#/components/schemas/ECommerceTotalSpentCondition' + ecommerce_product_purchased: '#/components/schemas/ECommerceProductPurchasedCondition' + ecommerce_brand_purchased: '#/components/schemas/ECommerceBrandPurchasedCondition' + sms_sent: '#/components/schemas/SmsSentCondition' + sms_delivered: '#/components/schemas/SmsDeliveredCondition' + sms_link_clicked: '#/components/schemas/SmsLinkClickedCondition' + sms_link_not_clicked: '#/components/schemas/SmsLinkNotClickedCondition' + ecommerce_abandoned_cart: '#/components/schemas/ECommerceAbandonedCartCondition' + custom_event: '#/components/schemas/CustomEventCondition' + NameCondition: + type: object + example: + conditionType: name + operatorType: string_operator + operator: contains + value: John + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionStringOperator' + EmailCondition: + type: object + example: + conditionType: email + operatorType: string_operator + operator: contains + value: john + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionStringOperator' + CustomFieldStringOperatorEnum: + description: >- + Allowed operators for `"operatorType":"string_operator"` and + `"operatorType":"string_operator_list"` + type: string + enum: + - is + - is_not + - contains + - not_contains + - starts + - ends + - not_starts + - not_ends + - assigned + - not_assigned + example: is + CustomFieldNumericOperatorEnum: + description: Allowed operators for `"operatorType":"numeric_operator"` + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + - assigned' + - not_assigned + example: numeric_lt + CustomFieldDateOperatorEnum: + description: Allowed operators for `"operatorType":"date_operator"` + type: string + enum: + - date_to + - date_from + - custom + - specific_date + - assigned + - not_assigned + example: date_to + CustomFieldValueForStringOperatorTypes: + description: >- + Any string, allowed only for `"operatorType":"string_operator"` and + `"operatorType":"string_operator_list"` + type: string + example: Canada + CustomFieldValueForNumericOperatorType: + description: Any number, allowed only for `"operatorType":"numeric_operator"` + type: string + example: '1' + CustomFieldValueForOperatorTypeDateAndOperatorSpecificDate: + description: >- + Allowed values for `"operatorType":"date_operator"` with + `"operator":"specific_date"` + type: string + enum: + - today + - yesterday + - last_7_days + - last_30_days + - last_n_days + - this_week + - last_week + - this_month + - last_month + - last_2_months + example: today + OpenedCondition: + description: Search contacts who did open a message. + type: object + example: + conditionType: opened + operatorType: message_operator + operator: autoresponder + value: 'SGNLr:' + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionMessageOperator' + GeolocationCondition: + description: Search contacts by geolocation. + required: + - operatorType + - operator + - value + - scope + properties: + scope: + description: Specify the search parameters + type: string + enum: + - country + - country_code + - region + - city + - longitude + - latitude + - postal_code + - dma_code + example: city + type: object + example: + conditionType: geo + operatorType: string_operator + operator: starts + value: New + scope: city + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionStringOperator' + CreateTransactionalEmail: + required: + - fromField + - subject + - recipients + - contentType + properties: + fromField: + $ref: '#/components/schemas/FromFieldReference' + replyTo: + $ref: '#/components/schemas/FromFieldReference' + tag: + $ref: '#/components/schemas/NewTransactionalEmailTag' + recipients: + $ref: '#/components/schemas/TransactionalEmailRecipients' + contentType: + description: The message content type + type: string + default: direct + enum: + - direct + - template + type: object + discriminator: + propertyName: contentType + mapping: + direct: '#/components/schemas/DirectContent' + template: '#/components/schemas/TemplateContent' + x-konfig-properties: + fromField: + description: The 'From' address ID to be used as the message sender + replyTo: + description: The 'From' address ID to be used as the Reply-to + tag: + description: The tag ID used for statistical data collection + DirectContent: + type: object + allOf: + - $ref: '#/components/schemas/CreateTransactionalEmail' + - $ref: '#/components/schemas/TransactionalEmailContent' + TemplateContent: + type: object + allOf: + - $ref: '#/components/schemas/CreateTransactionalEmail' + - $ref: '#/components/schemas/TransactionalEmailTemplate' + NewTransactionalEmailTag: + required: + - tagId + properties: + tagId: + type: string + example: vBd5 + type: object + TransactionalEmailContent: + required: + - content + properties: + subject: + type: string + maxLength: 512 + minLength: 1 + example: Order Confirmation - Example Shop + attachments: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailAttachment' + content: + description: >- + The message content. At least one field is required. The maximum + combined size of plain text and HTML is 16MB + properties: + plain: + type: string + example: Your order has been confirmed. Thank you for shopping with us! + html: + type: string + example: >- +

Your order has been confirmed

Thank you for + shopping with us! + type: object + type: object + TransactionalEmailTemplate: + description: The template content + required: + - template + properties: + template: + description: The message template. At least templateId is required + required: + - templateId + properties: + templateId: + description: Transactional emails template identifier + type: string + example: Ykz + lexpad: + description: Transactional email lexpad + type: object + example: + some-key: some-value + type: object + type: object + TransactionalEmailRecipients: + required: + - to + properties: + to: + $ref: '#/components/schemas/TransactionalEmailRecipient' + cc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipient' + bcc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipient' + type: object + TransactionalEmailRecipient: + required: + - email + properties: + email: + type: string + format: email + example: john.doe@example.com + name: + type: string + maxLength: 128 + minLength: 1 + example: John Doe + status: + type: string + enum: + - unknown + - sent + - rejected + - opened + - bounced + - reported_spam + readOnly: true + type: object + TransactionalEmailAttachment: + required: + - fileName + - content + - mimeType + properties: + fileName: + type: string + maxLength: 128 + minLength: 3 + example: pixel.png + mimeType: + description: The MIME attachment type + type: string + maxLength: 128 + minLength: 3 + example: image/png + content: + description: The base64-encoded attachment + type: string + format: base64 + example: >- + iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mOUua1dDwAD4AGjnrXmUAAAAABJRU5ErkJggg== + type: object + TransactionalEmailsTemplateDetails: + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmailsTemplateListElement' + - properties: + content: + $ref: '#/components/schemas/TransactionalEmailTemplateContent' + type: object + TransactionalEmailsTemplateListElement: + properties: + templateId: + description: Transactional email template ID + type: string + readOnly: true + example: p + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api3.getresponse360.com/v3/transactional-emails/templates/tRe4i + subject: + description: The template subject + type: string + example: Order Confirmation Template + createdOn: + description: The creation date + type: string + format: date-time + updatedOn: + description: The date of the last template update + type: string + format: date-time + editor: + description: The Editor type + allOf: + - type: string + enum: + - html + - wysiwyg + type: object + CreateTransactionalEmailTemplate: + required: + - subject + properties: + subject: + description: The template subject + type: string + example: Order Confirmation - Example Shop + content: + $ref: '#/components/schemas/TransactionalEmailTemplateContent' + type: object + TransactionalEmailTemplateContent: + description: The template content. At least one field is required + properties: + plain: + description: The plain text equivalent of template content + type: string + example: Your order has been confirmed. Thank you for shopping with us! + html: + description: The template content in HTML + type: string + example: >- +

Your order has been confirmed

Thank you for shopping + with us! + type: object + TransactionalEmailRecipientClickedLink: + properties: + url: + type: string + format: uri + readOnly: true + example: https://example.com + clickedOn: + type: string + format: date-time + readOnly: true + example: 2019-06-02T09:31:20+0200 + type: object + TransactionalEmailRecipientsDetails: + required: + - to + properties: + to: + $ref: '#/components/schemas/TransactionalEmailRecipient' + cc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipient' + bcc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipient' + type: object + TransactionalEmailTag: + required: + - tagId + properties: + tagId: + type: string + example: vBd5 + type: object + TransactionalEmailRecipientSentOnStatus: + properties: + sentOn: + type: string + format: date-time + readOnly: true + example: 2019-06-02T09:30:43+0200 + nullable: true + type: object + TransactionalEmailListElement: + required: + - transactionalEmailId + - recipients + - fromField + - subject + properties: + transactionalEmailId: + type: string + readOnly: true + example: tRe4i + fromField: + $ref: '#/components/schemas/FromFieldReference' + recipients: + allOf: + - required: + - to + properties: + to: + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipient' + - properties: + statuses: + $ref: >- + #/components/schemas/TransactionalEmailRecipientSentOnStatus + type: object + type: object + subject: + type: string + maxLength: 512 + minLength: 1 + example: Order Confirmation - Example Shop + tag: + $ref: '#/components/schemas/TransactionalEmailTag' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api3.getresponse360.com/v3/transactional-emails/tRe4i + type: object + TransactionalEmailStatistics: + properties: + timeFrame: + description: >- + The statistics time frame in the ISO 8601 date format with duration + interval + type: string + pattern: >- + /^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?(\/)P(?=\w*\d)(?:\d+Y|Y)?(?:\d+M|M)?(?:\d+W|W)?(?:\d+D|D)?(?:T(?:\d+H|H)?(?:\d+M|M)?(?:\d+(?:\­.\d{1,2})?S|S)?)?$/ + example: 2014-09-20T00:00:00+0000/P2M18DT10H0M0S + sent: + type: integer + format: int64 + opened: + type: integer + format: int64 + bounced: + type: integer + format: int64 + complaint: + type: integer + format: int64 + type: object + TransactionalEmail: + properties: + transactionalEmailId: + type: string + readOnly: true + example: tRe4i + type: object + FromField: + properties: + fromFieldId: + description: The 'From' address ID + type: string + readOnly: true + example: TTzW + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/TTzW + email: + description: The email address + type: string + format: email + example: jsmith@example.com + rewrittenEmail: + description: Email address used to send message. + type: string + format: email + example: jsmith@example.com + nullable: true + name: + description: The name connected to the email address + type: string + maxLength: 64 + minLength: 2 + example: John Smith + isActive: + $ref: '#/components/schemas/StringBooleanEnum' + isDefault: + $ref: '#/components/schemas/StringBooleanEnum' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + domain: + properties: + status: + description: Status of domain + type: string + enum: + - confirmed + - unconfirmed + - deleted + - can_not_be_used + - dns_configuration_pending + nullable: true + DKIMWarning: + description: DKIM warning status + type: string + enum: + - not_recommended + - can_not_be_used + - not_authenticated + - at_risk + nullable: true + type: object + type: object + x-konfig-properties: + isActive: + description: Flag if the 'From' address is active + readOnly: true + example: 'true' + isDefault: + description: Flag if the 'From' address is default for the account + readOnly: true + example: 'true' + FromFieldReference: + required: + - fromFieldId + properties: + fromFieldId: + description: The 'From' address ID + type: string + example: V + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/V + type: object + RssNewsletterSendSettingsListing: + required: + - frequency + - filter + properties: + frequency: + description: When to send the message + type: string + example: asap + filter: + description: The filter settings for an RSS post + type: string + enum: + - recent + - engaged + - shared + - commented + maxArticles: + description: How many articles to display in a list + type: integer + format: int32 + maximum: 30 + minimum: 1 + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSuppressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + discriminator: + propertyName: frequency + mapping: + asap: '#/components/schemas/RssNewsletterListSendAsapSettings' + daily: '#/components/schemas/RssNewsletterListSendDailySettings' + weekly: '#/components/schemas/RssNewsletterListSendWeeklySettings' + monthly: '#/components/schemas/RssNewsletterListSendMonthlySettings' + RssNewsletterListing: + required: + - rssNewsletterId + - href + properties: + rssNewsletterId: + description: The RSS newsletter ID + type: string + readOnly: true + example: dGer + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/rss-newsletters/dGer + rssFeedUrl: + description: The URL for the RSS Feed + type: string + format: uri + example: http://blog.getresponse.com + subject: + description: The RSS message subject + type: string + maxLength: 255 + minLength: 1 + example: My rss to newsletters + name: + description: How your newsletters will be seen inside the application + type: string + maxLength: 255 + minLength: 1 + example: rsstest0 + status: + $ref: '#/components/schemas/StatusEnum' + editor: + $ref: '#/components/schemas/MessageEditorEnum' + fromField: + $ref: '#/components/schemas/FromFieldReference' + replyTo: + $ref: '#/components/schemas/FromFieldReference' + content: + $ref: '#/components/schemas/MessageContent' + sendSettings: + $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + x-konfig-properties: + status: + description: The status of the RSS newsletter + example: enabled + fromField: + description: The 'From' email address used for the message + replyTo: + description: The email that will be used as a reply-to address + sendSettings: + description: How the message will be delivered to the subscriber + MessageSendSettingSelectedCampaigns: + description: The list of campaign IDs to choose subscribers from. + items: + type: string + example: C + MessageSendSettingSelectedSegments: + description: The list of segment IDs to choose subscribers from. + items: + type: string + example: Se + MessageSendSettingSelectedSuppressions: + description: The list of suppression IDs to exclude subscribers. + items: + type: string + example: Ss + MessageSendSettingExcludedCampaigns: + description: The list of campaign IDs to exclude subscribers. + items: + type: string + example: eC + MessageSendSettingExcludedSegments: + description: The list of segment IDs to exclude subscribers. + items: + type: string + example: eSs + MessageSendSettingSelectedContacts: + description: The list of selected contacts. + items: + type: string + example: eSs + BaseCampaign: + properties: + campaignId: + description: Campaign ID + type: string + readOnly: true + example: V3J + name: + description: >- + The campaign (list) name. + + + * You can use each list name just once in your account. + + + * The name must be between 3-64 characters. + + + * All alphabets supported by GetResponse, including right-to-left + ones, are allowed. + + + * You can use upper and lower case letters, numbers, spaces and + special characters apart from the ones listed below. + + + * You can’t use emojis and the following special characters: `/`, + `\`, `@`, and `[` or `]`. + type: string + maxLength: 64 + minLength: 3 + example: my_campaign + techName: + description: >- + Tech name is a unique internal ID of a list used for [FTP + imports](https://www.getresponse.com/help/how-to-import-files-via-ftp.html) + (available in GetResponse MAX accounts only) + type: string + readOnly: true + example: my_campaign + languageCode: + description: >- + The campaign language code according to ISO 639-1, plus: zt - + Chinese (Traditional), fs - Afghan Persian (Dari), md - Moldavian + type: string + example: EN + isDefault: + $ref: '#/components/schemas/StringBooleanEnum' + createdOn: + description: The date of creation + type: string + format: date-time + readOnly: true + example: 2014-02-12T15:19:21+0000 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/campaigns/V3J + type: object + x-konfig-properties: + isDefault: + description: Is the campaign default + example: 'true' + CampaignAdditionalProperties: + properties: + postal: + $ref: '#/components/schemas/CampaignPostal' + confirmation: + $ref: '#/components/schemas/CampaignConfirmation' + optinTypes: + $ref: '#/components/schemas/CampaignOptinTypes' + subscriptionNotifications: + $ref: '#/components/schemas/CampaignSubscriptionNotifications' + profile: + $ref: '#/components/schemas/CampaignProfile' + type: object + Campaign: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseCampaign' + - $ref: '#/components/schemas/CampaignAdditionalProperties' + CampaignConfirmation: + properties: + fromField: + $ref: '#/components/schemas/FromFieldReference' + redirectType: + description: >- + What will happen after email confirmation. The values allowed + include: hosted (the subscriber will stay on the default GetResponse + website), customUrl (the subscriber will be redirected to a custom + URL provided by the user). + type: string + enum: + - hosted + - customUrl + example: hosted + mimeType: + description: The MIME type for the confirmation message + type: string + enum: + - text/html + - text/plain + - combo + example: text/plain + redirectUrl: + description: >- + Required if the redirectType is customUrl. The URL a subscriber will + be redirected to if the redirectType is set to customUrl. + type: string + format: uri + example: http://example.com + replyTo: + $ref: '#/components/schemas/FromFieldReference' + subscriptionConfirmationBodyId: + description: The subscription confirmation body ID + type: string + example: asS1 + subscriptionConfirmationSubjectId: + description: Subscription confirmation subject ID + type: string + example: TEww + type: object + CampaignOptinTypes: + properties: + email: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + - double + example: single + api: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + - double + example: single + import: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + example: single + webform: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + - double + example: single + type: object + CampaignPostal: + properties: + addPostalToMessages: + $ref: '#/components/schemas/StringBooleanEnum' + city: + description: The city, free-text + type: string + example: London + companyName: + description: The company name, free-text + type: string + example: Company Ltd. + country: + description: The country name, free-text + type: string + example: Great Britain + design: + description: >- + How the postal address will display in messages. The available + fields include: [[name]], [[address]], [[city]], [[state]] [[zip]], + [[country]] + type: string + example: '[[name]] from [[city]] in [[country]]' + state: + description: The state, free-text + type: string + example: Shire + street: + description: The street, free-text + type: string + example: Bilbo Baggins Av + zipCode: + description: The ZIP code + type: string + example: 81-611 + type: object + x-konfig-properties: + addPostalToMessages: + description: >- + Should the postal address be included in all message footers for + this campaign (mandatory for Canada and the US) + example: 'true' + CampaignProfile: + properties: + title: + description: The profile title + type: string + maxLength: 64 + minLength: 2 + example: title + description: + description: The campaign description + type: string + maxLength: 255 + minLength: 2 + example: campaign description + industryTagId: + description: The industry tag ID + type: string + format: integer + example: '1' + logo: + description: The logo URL + type: string + format: uri + example: http://logos.com/imageupdated.jpg + logoLinkUrl: + description: The logo link URL + type: string + format: uri + example: http://somePageLogoLinkUpdated.com + type: object + CampaignSubscriptionNotifications: + properties: + status: + $ref: '#/components/schemas/StatusEnum' + recipients: + type: array + items: + $ref: '#/components/schemas/FromFieldReference' + type: object + x-konfig-properties: + status: + description: >- + Are notifications enabled. Possible values include: enabled, + disabled. + example: enabled + Account: + properties: + accountId: + description: Account ID + type: string + readOnly: true + example: VfEy1 + email: + description: Email + type: string + format: email + readOnly: true + example: john.smith@test.com + countryCode: + readOnly: true + $ref: '#/components/schemas/AccountDetailsCountryCode' + industryTag: + readOnly: true + $ref: '#/components/schemas/IndustryTagId' + timeZone: + readOnly: true + allOf: + - $ref: '#/components/schemas/TimezoneName' + - $ref: '#/components/schemas/TimezoneOffset' + href: + description: Direct URL to resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/accounts + firstName: + description: First name + type: string + maxLength: 64 + minLength: 2 + example: John + lastName: + description: Last name + type: string + maxLength: 64 + minLength: 2 + example: Smith + companyName: + description: Company name + type: string + maxLength: 64 + minLength: 2 + example: MyBigCompany + phone: + description: Phone number + type: string + maxLength: 32 + minLength: 2 + example: '+00155555555' + state: + description: State + type: string + maxLength: 40 + minLength: 2 + example: Oklahoma + city: + description: City + type: string + example: Alderson + street: + description: Street + type: string + maxLength: 64 + minLength: 2 + example: Sunset blv. + zipCode: + description: ZIP Code + type: string + maxLength: 9 + minLength: 2 + example: 81-611 + numberOfEmployees: + description: Numbers of employees + type: string + enum: + - '50' + - '250' + - '500' + - more + example: '500' + timeFormat: + description: Account time notation + type: string + enum: + - 12h + - 24h + example: 24h + type: object + AutoresponderTriggerSettings: + required: + - type + - dayOfCycle + - selectedCampaigns + properties: + type: + description: The trigger type + type: string + items: + type: string + enum: + - onday + default: onday + dayOfCycle: + description: >- + For onday type the day of the autoresponder cycle in the 0-9999 + format + type: integer + format: int32 + maximum: 9999 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + autoresponder: + type: string + readOnly: true + nullable: true + newsletter: + type: string + readOnly: true + nullable: true + clickTrackId: + type: string + readOnly: true + nullable: true + goal: + type: string + readOnly: true + nullable: true + custom: + type: string + readOnly: true + nullable: true + newCustomValue: + type: string + readOnly: true + nullable: true + action: + type: string + readOnly: true + nullable: true + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + type: object + AutoresponderSendSettings: + required: + - type + properties: + type: + description: When to send the message + type: string + enum: + - signup + - immediately + - delay + - custom + delayInHours: + description: >- + How many hours to delay the message after a trigger occured, in the + 0-23 format + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + sendAtHour: + description: >- + The specific hour on which the message will be sent, in the 0-23 + format + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + recurrence: + $ref: '#/components/schemas/StringBooleanEnum' + timeTravel: + $ref: '#/components/schemas/StringBooleanEnum' + excludedDaysOfWeek: + description: >- + The days of the week to exclude from message sending (the message + will be sent on the next non-excluded day after the trigger) + type: array + items: + type: string + enum: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + externalLexpad: + description: >- + External Lexpad settings for the message, read more: [External + Lexpad](https://apidocs.getresponse.com/v3/dynamic-content/external-lexpad) + nullable: true + allOf: + - $ref: '#/components/schemas/ExternalLexpad' + type: object + discriminator: + propertyName: type + mapping: + signup: '#/components/schemas/AutoresponderSendSignupSettings' + immediately: '#/components/schemas/AutoresponderSendImmediatelySettings' + delay: '#/components/schemas/AutoresponderSendDelaySettings' + custom: '#/components/schemas/AutoresponderSendCustomSettings' + x-konfig-properties: + recurrence: + description: >- + Should the message be sent every time the trigger occurs (example: + each click) + example: 'false' + timeTravel: + description: >- + Should the message be sent in the user's or the subscriber's time + zone + example: 'true' + Autoresponder: + required: + - autoresponderId + - href + properties: + autoresponderId: + description: The autoresponder ID + type: string + readOnly: true + example: Q + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/autoresponders/Q + name: + description: The autoresponder name + type: string + maxLength: 128 + minLength: 2 + example: Message 2 + subject: + description: The autoresponder message subject + type: string + maxLength: 128 + minLength: 2 + example: test12 + campaignId: + description: >- + The campaign ID. The system will assign the autoresponder to a + default campaign if you don't provide a specific campaign ID. + type: string + example: V + status: + $ref: '#/components/schemas/StatusEnum' + editor: + $ref: '#/components/schemas/MessageEditorEnum' + fromField: + $ref: '#/components/schemas/FromFieldReference' + replyTo: + $ref: '#/components/schemas/FromFieldReference' + content: + $ref: '#/components/schemas/MessageContent' + flags: + $ref: '#/components/schemas/MessageFlagsArray' + sendSettings: + $ref: '#/components/schemas/AutoresponderSendSettings' + triggerSettings: + $ref: '#/components/schemas/AutoresponderTriggerSettings' + statistics: + description: The autoresponder statistics summary + type: object + readOnly: true + allOf: + - properties: + delivered: + type: number + format: float + example: 0 + openRate: + type: number + format: float + example: 0 + clickRate: + type: number + format: float + example: 0 + type: object + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + x-konfig-properties: + status: + description: The autoresponder status + example: enabled + fromField: + description: The from email address used for the message + replyTo: + description: The email that will be used as a reply-to address + sendSettings: + description: How the message will be delivered to the subscriber + triggerSettings: + description: 'The conditions that will trigger the autoresponder ' + RssNewsletterSendSettingsDetails: + required: + - frequency + - filter + properties: + frequency: + description: When to send the message + type: string + example: asap + filter: + description: The filter settings for an RSS post + type: string + enum: + - recent + - engaged + - shared + - commented + maxArticles: + description: How many articles to display in a list + type: integer + format: int32 + maximum: 30 + exclusiveMaximum: false + minimum: 1 + exclusiveMinimum: false + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSuppressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + selectedContacts: + $ref: '#/components/schemas/MessageSendSettingSelectedContacts' + type: object + discriminator: + propertyName: frequency + mapping: + asap: '#/components/schemas/RssNewsletterSendAsapSettings' + daily: '#/components/schemas/RssNewsletterSendDailySettings' + weekly: '#/components/schemas/RssNewsletterSendWeeklySettings' + monthly: '#/components/schemas/RssNewsletterSendMonthlySettings' + RssNewsletter: + required: + - rssNewsletterId + - href + properties: + rssNewsletterId: + description: The RSS newsletter ID + type: string + readOnly: true + example: dGer + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/rss-newsletters/dGer + rssFeedUrl: + description: The URL for the RSS Feed + type: string + format: uri + example: http://blog.getresponse.com + subject: + description: The RSS message subject + type: string + maxLength: 255 + minLength: 1 + example: My rss to newsletters + name: + description: How your newsletters will be seen inside the application + type: string + maxLength: 255 + minLength: 1 + example: rsstest0 + status: + $ref: '#/components/schemas/StatusEnum' + editor: + $ref: '#/components/schemas/MessageEditorEnum' + fromField: + $ref: '#/components/schemas/FromFieldReference' + replyTo: + $ref: '#/components/schemas/FromFieldReference' + content: + $ref: '#/components/schemas/MessageContent' + sendSettings: + $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + x-konfig-properties: + status: + description: The status of the RSS newsletter + example: enabled + fromField: + description: The 'From' email address used for the message + replyTo: + description: The email that will be used as a reply-to address + sendSettings: + description: How the message will be delivered to the subscriber + MessageFlagsArray: + description: The message flags. + type: array + items: + type: string + enum: + - openrate + - clicktrack + - google_analytics + MessageFlagsString: + description: >- + Comma-separated list of message flags. The possible values are: + `openrate`, `clicktrack`, and `google_analytics`. + type: string + example: openrate,clicktrack,google_analytics + MessageEditorEnum: + description: >- + How the message was created: `custom` means a custom-made message, + `text` means plain text content, `getresponse` means that the message + was created using the GetResponse editor. + type: string + enum: + - custom + - text + - getresponse + - legacy + - html2 + MessageContent: + description: The message content. + properties: + html: + description: The message content in HTML + type: string + maxLength: 524288 + example: >- +

test 12

Some test http://example.com

+ plain: + description: The plain text equivalent of the message content + type: string + maxLength: 524288 + example: test 12 Some test + type: object + Contact: + required: + - contactId + - href + - email + properties: + contactId: + type: string + readOnly: true + example: pV3r + name: + type: string + maxLength: 128 + minLength: 1 + example: John Doe + origin: + type: string + enum: + - import + - email + - www + - panel + - leads + - sale + - api + - forward + - survey + - iphone + - copy + - landing_page + - website_builder_elegant + readOnly: true + timeZone: + description: >- + The time zone of a contact, uses the time zone database format + (https://www.iana.org/time-zones) + type: string + readOnly: true + example: Europe/Warsaw + activities: + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/contacts/pV3r/activities + changedOn: + type: string + format: date-time + readOnly: true + example: 2017-12-19T13:11:48+0000 + createdOn: + type: string + format: date-time + readOnly: true + example: 2017-03-02T07:30:49+0000 + campaign: + type: object + $ref: '#/components/schemas/CampaignReference' + email: + type: string + format: email + example: john.doe@example.com + dayOfCycle: + description: >- + The day on which the contact is in the Autoresponder cycle. `null` + indicates the contacts is not in the cycle. + type: string + example: '42' + nullable: true + scoring: + description: Contact scoring, pass null to remove the score from a contact + type: number + example: 8 + nullable: true + engagementScore: + description: >- + Engagement Score is a feature that presents a visual estimate of a + contact's engagement with mailings. The score is based on the + contact's interactions with your e-mails. Via API, it's returned in + the form of numbers ranging from 1 (Not Engaged) to 5 (Highly + Engaged). + type: integer + format: int32 + maximum: 5 + minimum: 1 + readOnly: true + example: 3 + nullable: true + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/contacts/pV3r + type: object + NewContactCustomFieldValue: + required: + - customFieldId + - value + properties: + customFieldId: + description: Custom field ID + type: string + example: kL6Nh + value: + type: array + items: + type: string + example: 18-35 + type: object + NewContactTag: + required: + - tagId + properties: + tagId: + type: string + example: m7E2 + type: object + ContactTag: + properties: + tagId: + type: string + example: hR + name: + type: string + example: super_promo + href: + type: string + format: uri + example: https://api.getresponse.com/v3/tags/hR + color: + type: string + deprecated: true + type: object + NewContactTags: + properties: + tags: + type: array + items: + $ref: '#/components/schemas/NewContactTag' + type: object + NewContactCustomFieldValues: + properties: + customFieldValues: + type: array + items: + $ref: '#/components/schemas/NewContactCustomFieldValue' + type: object + NewContact: + required: + - email + - campaign + type: object + allOf: + - $ref: '#/components/schemas/Contact' + - properties: + ipAddress: + description: The contact's IP address. IPv4 and IPv6 formats are accepted. + example: 1.2.3.4 + oneOf: + - type: string + format: ipv4 + - type: string + format: ipv6 + type: object + - $ref: '#/components/schemas/NewContactTags' + - $ref: '#/components/schemas/NewContactCustomFieldValues' + UpdateContact: + type: object + allOf: + - $ref: '#/components/schemas/Contact' + - properties: + note: + type: string + maxLength: 255 + minLength: 0 + nullable: true + type: object + - $ref: '#/components/schemas/NewContactTags' + - $ref: '#/components/schemas/NewContactCustomFieldValues' + CustomFieldTypeEnum: + type: string + enum: + - text + - textarea + - radio + - checkbox + - single_select + - multi_select + - number + - date + - datetime + - country + - currency + - phone + - gender + - ip + - url + CustomFieldFormatEnum: + type: string + enum: + - text + - textarea + - radio + - checkbox + - single_select + - multi_select + CustomField: + properties: + customFieldId: + description: Custom field ID + type: string + readOnly: true + example: pas + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/custom-fields/pas + name: + description: >- + The name of the custom field. It must meet the following + requirements: + * be unique + * use only lowercase letters, underscores and digits + * not be equal to one of the merge words used in messages, i.e. `name, email, twitter, facebook, buzz, myspace, linkedin, digg, googleplus, pinterest, responder, campaign, change`. + type: string + maxLength: 128 + minLength: 1 + example: office_phone_number + type: + $ref: '#/components/schemas/CustomFieldTypeEnum' + valueType: + description: >- + Type of returning value, it returns `format` options extended by a + `string` option if the `format` was not defined + type: string + enum: + - string + - number + - date + - datetime + - country + - currency + - phone + - gender + - ip + - url + readOnly: true + example: phone + format: + $ref: '#/components/schemas/CustomFieldFormatEnum' + fieldType: + description: Returns the same data as `type` + type: string + readOnly: true + example: text + deprecated: true + hidden: + $ref: '#/components/schemas/StringBooleanEnum' + values: + description: >- + The list of assigned values (zero or more - depending on the custom + field type. Please see description) + type: array + items: + type: string + example: '+48600100200' + type: object + x-konfig-properties: + type: + description: |- + The custom field `type` accepts the following values: + * `text` - text input (doesn't require values in the `values` field, you can pass empty array) + * `textarea` - textarea input (does n't require values in the `values` field, you can pass empty array) + * `radio` - radio input (requires at least 2 values in the `values` field) + * `checkbox` - checkbox input (requires at least 2 values in the `values` field) + * `single_select` - single select input (requires at least 2 values in the `values` field) + * `multi_select` - multi select input (requires at least 2 values in the `values` field) + * `number` - text input for a numeric value (doesn't require values in the `values` field, you can pass empty array) + * `date` - text input for a date (doesn't require values in the `values` field, you can pass empty array) + * `datetime` - text input for date and time (doesn't require values in the `values` field, you can pass empty array) + * `country` - multi select input for a country (requires at least 2 country names in the `values` field) + * `currency` - multi select for a currency, allows all ISO 4217 currency codes (requires at least 2 currency codes in the `values` field) + * `phone` - text input for a phone number (doesn't require values in the `values` field, you can pass empty array) + * `gender` - radio input for gender (requires 2 values in the `values` field: `Male` and `Female`, that can be translated into one of the languages supported by GetResponse) + * `ip` - text input for an IP address (doesn't require values in the `values` field, you can pass empty array) + * `url` - text input for a URL (doesn't require values in the `values` field, you can pass empty array). + example: phone + format: + description: |- + The custom field `format` accepts following values: + * `text` - text input (doesn't require values in the `values` field, you can pass empty array) + * `textarea` - textarea input (doesn't require values in the `values` field, you can pass empty array) + * `radio` - radio input (requires at least 2 values in the `values` field) + * `checkbox` - checkbox input (requires at least 2 values in the `values` field) + * `single_select` - single select input (requires at least 2 values in the `values` field) + * `multi_select` - multi select input (requires at least 2 values in the `values` field). + example: text + hidden: + description: Whether the custom field is visible to contacts + example: 'false' + UpdateCustomField: + required: + - hidden + - values + properties: + hidden: + $ref: '#/components/schemas/StringBooleanEnum' + values: + description: >- + The list of assigned values (zero or more - depending on the custom + field type. Please see description) + type: array + items: + type: string + example: '+48600100200' + type: object + x-konfig-properties: + hidden: + description: Whether the custom field is visible to contacts + example: 'false' + UpdatePredefinedField: + required: + - value + properties: + value: + type: string + maxLength: 350 + minLength: 1 + pattern: ^[A-Za-z_]{1,350}$ + example: my_new_value + type: object + UpdateCallbacks: + properties: + url: + description: >- + URL to use to post notifications, required if callbacks are not yet + enabled + type: string + format: uri + example: https://example.com/callback + actions: + type: object + $ref: '#/components/schemas/CallbackActions' + type: object + TriggerCustomEvent: + required: + - name + - contactId + properties: + name: + description: >- + The name of custom event. Custom event with this name must already + exist + type: string + maxLength: 64 + minLength: 3 + pattern: ^[a-z0-9_]{3,64}$ + example: lesson_finished + contactId: + description: The contact ID + type: string + example: lTgH5 + attributes: + description: The attributes for the trigger + type: array + items: + $ref: '#/components/schemas/TriggerCustomEventAttribute' + type: object + TriggerCustomEventAttribute: + required: + - name + - value + properties: + name: + description: >- + The name of the attribute. It must be already defined for the custom + event + type: string + maxLength: 64 + minLength: 3 + example: lesson_name + value: + example: lesson_3 + $ref: '#/components/schemas/TriggerCustomEventAttributeValue' + type: object + TriggerCustomEventAttributeValue: + description: >- + The value of the attribute. Value type depends on the attribute + definition + oneOf: + - type: string + maxLength: 255 + minLength: 1 + example: lesson_3 + - $ref: '#/components/schemas/StringBooleanEnum' + - type: boolean + - description: 'Date in extended ISO 8601 datetime format: *2019-01-01T08:00:00+00*' + type: string + format: date-time + example: 2019-01-01T08:00:00+0000 + - type: integer + format: int64 + example: 1500 + CustomEvent: + required: + - name + - attributes + properties: + name: + description: Unique name of custom event + type: string + pattern: ^[a-z0-9_]{3,64}$ + example: sample_custom_event + attributes: + description: Optional collection of attributes + type: array + items: + $ref: '#/components/schemas/CustomEventAttribute' + type: object + CustomEventAttribute: + required: + - name + - type + properties: + name: + description: Unique name of attribute + type: string + pattern: ^[a-z0-9_]{3,64}$ + example: sample_attribute + type: + description: Type of attribute + enum: + - string + - number + - datetime + - boolean + example: string + type: string + type: object + FormVariant: + properties: + variant: + description: The index of variants + type: string + readOnly: true + example: '0' + variantName: + type: string + example: Variant A + winner: + description: Is this variant the winner in the A/B test + $ref: '#/components/schemas/StringBooleanEnum' + status: + type: string + enum: + - published + - unpublished + - disabled + createdOn: + type: string + format: date-time + example: 2018-07-11T13:37:25+0000 + statistics: + $ref: '#/components/schemas/FormStatistics' + type: object + FormVariantDetails: + properties: + formId: + type: string + readOnly: true + example: pL4e + webformId: + description: Same as `formId` + type: string + readOnly: true + example: pL4e + variant: + description: The index of variants + type: string + readOnly: true + example: '0' + variantName: + type: string + example: Variant A + winner: + description: Is this variant the winner in the A/B test + type: string + enum: + - 'yes' + - 'no' + status: + type: string + enum: + - published + - unpublished + - disabled + createdOn: + type: string + format: date-time + example: 2018-07-09T15:45:12+0000 + numberOfVisitors: + description: The total number of form visitors + type: integer + format: int64 + example: 152 + numberOfUniqueVisitors: + description: The number of unique form visitors + type: integer + format: int64 + example: 136 + numberOfSubscribers: + description: The number of visitors who subscribed through this form + type: integer + format: int64 + example: 94 + subscriptionRate: + description: The ratio of `numberOfSubscribers` to `numberOfVisitors` + type: number + format: double + example: 0.62 + type: object + FormDetails: + type: object + allOf: + - $ref: '#/components/schemas/Form' + - properties: + settings: + $ref: '#/components/schemas/FormSettings' + variants: + type: array + items: + $ref: '#/components/schemas/FormVariant' + type: object + FormSettings: + properties: + optin: + description: >- + `single` - Single opt-in means that the contact will be added + without confirming their subscription first. `double` - Double + opt-in means that the contact will receive a subscription + confirmation email. + type: string + enum: + - single + - double + example: single + phase: + description: >- + The contact who subscribed via this form will be added to the + selected day in the autoresponder cycle. If null, the contact won't + be added to the cycle. + type: integer + format: int32 + maximum: 9999 + minimum: 0 + example: 5 + nullable: true + thankYouType: + description: What should happen when a new contact subscribes via the form. + type: string + enum: + - stay_on_page + - default + - custom_url + example: stay_on_page + thankYouUrl: + description: >- + The URL used to redirect the newly subscribed contacts when they + complete this form. Used if `thankYouType` is `custom_url`. + type: string + format: uri + example: https://example.com/thank-you + nullable: true + alreadySubscribedType: + description: What to do when the address already exists in the campaign + type: string + enum: + - stay_on_page + - default + - custom_url + example: stay_on_page + alreadySubscribedUrl: + description: >- + The URL used to redirect the already subscribed contacts when they + complete this form. Used if `alreadySubscribedType` is `custom_url`. + type: string + format: uri + example: https://example.com/thank-you + nullable: true + secondStageCaptcha: + description: Is captcha enabled for the form + $ref: '#/components/schemas/StringBooleanEnum' + forwardDataRequestType: + description: >- + How to forward form data to a thank-you page. [Learn + more](https://www.getresponse.com/help/building-contact-lists/forms-and-pop-ups/can-i-forward-subscriber-data-to-a-custom-thank-you-page.html). + `null` means that the data forwarding is turned off. + type: string + enum: + - GET + - POST + nullable: true + trackingCustomField: + description: >- + Subscribers added via this form will have this custom field set with + a value passed in `trackingCustomFieldValue` + type: string + nullable: true + $ref: '#/components/schemas/CustomFieldReference' + trackingCustomFieldValue: + description: See the `trackingCustomField` description + type: string + example: '123' + nullable: true + type: object + Form: + properties: + formId: + type: string + readOnly: true + example: pL4e + webformId: + description: Same as `formId` + type: string + readOnly: true + example: pL4e + name: + type: string + example: My first form + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/forms/pL4e + hasVariants: + description: Indicates if the form has variants (A/B tests) + type: boolean + readOnly: true + example: true + scriptUrl: + description: >- + The URL to a JavaScript file of the form. This is used to embed the + form within a web page. + type: string + format: uri + readOnly: true + example: >- + https://app.getresponse.com/view_webform_v2.js?u=nTfa&webforms_id=123 + status: + type: string + enum: + - published + - unpublished + - draft + example: published + createdOn: + type: string + format: date-time + example: 2018-07-02T11:22:33+0000 + statistics: + $ref: '#/components/schemas/FormStatistics' + campaign: + $ref: '#/components/schemas/CampaignReference' + type: object + FormStatistics: + properties: + visitors: + description: The total number of form visitors + type: integer + format: int64 + example: 4371 + uniqueVisitors: + description: The number of unique form visitors + type: integer + format: int64 + example: 3865 + subscribed: + description: The number of visitors that subscribed using this form + type: integer + format: int64 + example: 2594 + subscriptionRate: + description: The ratio of `subscribed` to `visitors` + type: number + format: double + example: 0.59 + type: object + BaseLandingPage: + properties: + landingPageId: + description: The landing page ID + type: string + example: avYn + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/landing-pages/avYn + metaTitle: + description: The landing page meta title property + type: string + example: Some meta title + domain: + description: The domain where the landing page is hosted + type: string + example: gr8.new + subdomain: + description: The subdomain where the landing page is assigned + type: string + example: summer-sale + userDomain: + description: The private domain provided by the user + type: string + example: '' + userDomainPath: + description: The private domain path provided by the user + type: string + example: '' + campaign: + $ref: '#/components/schemas/CampaignReference' + status: + $ref: '#/components/schemas/StatusEnum' + userDomainStatus: + description: >- + The DNS status for the user's private domain. Can be `null` if a + private domain isn't assigned. + type: string + enum: + - active + - inactive + - waiting + nullable: true + testAB: + $ref: '#/components/schemas/StringBooleanEnum' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + updatedOn: + description: The date of the last page update + type: string + format: date-time + readOnly: true + type: object + x-konfig-properties: + campaign: + description: The campaign to which the landing page is linked + status: + description: The landing page status + testAB: + description: Does the landing page have AB testing (variants) enabled + example: 'true' + LandingPageVariant: + properties: + variantId: + description: The landing page variant ID. + type: string + example: PKxn + variant: + description: The variant index. + type: string + format: integer + example: '0' + winner: + type: boolean + example: true + visitors: + type: string + format: integer + example: '12' + uniqueVisitors: + type: string + format: integer + example: '2' + subscribed: + type: string + format: integer + example: '2' + type: object + NewImport: + required: + - campaignId + - contacts + - fieldMapping + properties: + campaignId: + description: The ID of the destination campaign (list) + type: string + example: z5c + fieldMapping: + description: >- + Mapping definition for such contact properties as email address, + name, or custom fields. It's the equivalent of column headers in a + CSV file used to import contacts in a GetResponse account. The + `email` value is required. For custom fields, provide only custom + fields name in the mapping. Include their values in the + corresponding field in the contact array + type: array + items: + type: string + example: email + contacts: + description: >- + Container for a contact definition. Include the values defined in + the `fieldMapping` array + type: array + items: + $ref: '#/components/schemas/NewImportContact' + type: object + NewImportContact: + type: array + items: + type: string + example: example@somedomain.com + Import: + properties: + importId: + description: The import ID + type: string + readOnly: true + example: o6gE + campaign: + type: object + $ref: '#/components/schemas/CampaignReference' + status: + type: string + enum: + - uploaded + - review + - approved + - rejected + - finished + - canceled + - to_review + readOnly: true + statistics: + description: The import statistics + type: object + $ref: '#/components/schemas/ImportStatistics' + errorStatistics: + description: The detailed import error statistics + type: object + $ref: '#/components/schemas/ImportErrorStatistics' + createdOn: + type: string + format: date-time + finishedOn: + type: string + format: date-time + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/imports/o6gE + type: object + ImportStatistics: + required: + - uploaded + - invalid + - updated + - addedToList + properties: + uploaded: + description: The number of uploaded contacts + type: integer + format: int64 + readOnly: true + example: 25 + invalid: + description: The number of invalid contacts + type: integer + format: int64 + readOnly: true + example: 5 + updated: + description: The number of updated contacts + type: integer + format: int64 + readOnly: true + example: 10 + addedToList: + description: The number of added contacts + type: integer + format: int64 + readOnly: true + example: 10 + type: object + ImportErrorStatistics: + properties: + syntaxErrors: + description: The number of contacts with a syntax error + type: integer + format: int64 + readOnly: true + example: 2 + alreadyInQueue: + description: The number of contacts already in queue + type: integer + format: int64 + readOnly: true + example: 1 + invalidDomains: + description: The number of contacts with invalid domains + type: integer + format: int64 + readOnly: true + example: 1 + blacklist: + description: The number of blocked contacts + type: integer + format: int64 + readOnly: true + example: 1 + policyFailures: + description: The number of contacts rejected for policy reasons + type: integer + format: int64 + readOnly: true + example: 1 + mismatchedCriteria: + description: >- + The number of contacts rejected because of mismatched criteria, + [learn + more](https://www.getresponse.com/help/managing-contacts/working-with-contact-lists/where-can-i-find-import-statistics.html#what-do-the-numbers-for-uploaded-approved-and-import-errors-mean) + type: integer + format: int64 + readOnly: true + example: 1 + type: object + SmsStats: + required: + - smsId + properties: + smsId: + description: The SMS message ID + type: string + example: PvLI8C + totalSms: + description: The number of SMS messages sent + type: integer + example: 1 + totalRecipients: + description: The number of recipients + type: integer + example: 1 + totalClicks: + description: The number of link clicks from an SMS message + type: integer + example: 1 + totalUnsubscribes: + description: The number of opt-outs from an SMS message + type: integer + example: 1 + totalPrice: + description: Cost details of a specific SMS + type: object + nullable: false + allOf: + - properties: + amount: + description: Total SMS message cost + type: string + example: '0.0240' + currency: + description: Pricing currency + type: string + example: USD + type: object + link: + description: Link details + type: object + nullable: false + allOf: + - properties: + url: + description: Link URL + type: string + example: https://getresponse.com + clicks: + description: The number of link clicks from an SMS message + type: integer + example: 1 + type: object + countryStatistics: + description: SMS message statistics per country + type: object + nullable: false + allOf: + - properties: + countryCode: + description: Country code + type: string + example: PL + recipients: + description: The number of recipients + type: integer + example: 1 + smsCount: + description: The number of messages sent + type: integer + example: 1 + price: + description: Pricing details + type: object + allOf: + - properties: + price: + description: Total cost + type: string + example: '0.0240' + currency: + description: Pricing currency + type: string + example: USD + type: object + type: object + type: object + RevenueStatistics: + properties: + currency: + description: Statistics currency + type: string + example: USD + timeSeries: + type: array + items: + properties: + timeInterval: + description: >- + Orders and revenue are grouped by time intervals. Interval + length is set automatically and depends on the `orderDate` + parameter. + type: string + pattern: >- + /^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?(\/)P(?=\w*\d)(?:\d+Y|Y)?(?:\d+M|M)?(?:\d+W|W)?(?:\d+D|D)?(?:T(?:\d+H|H)?(?:\d+M|M)?(?:\d+(?:\­.\d{1,2})?S|S)?)?$/ + example: 2014-09-20T00:00:00+0000/P2M18DT10H0M0S + revenue: + description: Revenue + type: number + example: 2.45 + orders: + description: Number of orders + type: integer + example: 5 + type: object + type: object + GeneralPerformanceStats: + properties: + currency: + description: Statistics currency + type: string + example: USD + order: + description: Order statistics + type: object + nullable: false + allOf: + - properties: + orders: + description: Number of orders + type: integer + example: 5 + ordersTrend: + description: Order trend + type: number + example: 1.23 + avgOrderRevenue: + description: Average order value + type: number + example: 1.23 + avgOrderRevenueTrend: + description: Average order value trend + type: number + example: 1.23 + type: object + revenue: + description: Revenue statistics + type: object + nullable: false + allOf: + - properties: + revenue: + description: Revenue from orders + type: number + example: 1.23 + revenueTrend: + description: Revenue trend + type: number + example: 1.23 + type: object + type: object + PredefinedField: + properties: + predefinedFieldId: + type: string + readOnly: true + example: 6neM + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/predefined-fields/6neM + name: + type: string + maxLength: 32 + minLength: 1 + pattern: ^[A-Za-z0-9_]{1,32}$ + example: my_predefined_field_123 + value: + type: string + maxLength: 350 + minLength: 1 + example: my value + campaign: + type: object + $ref: '#/components/schemas/CampaignReference' + type: object + Suppression: + required: + - suppressionId + properties: + suppressionId: + description: The suppression ID + type: string + readOnly: true + example: pypF + name: + description: The suppression name + type: string + example: suppression-name + createdOn: + description: Created on DateTime in the ISO8601 format + type: string + format: date-time + readOnly: true + example: 2018-07-26T06:33:13+0000 + href: + description: Direct hyperlink to a resource + type: string + readOnly: true + example: https://api.getresponse.com/v3/suppressions/pypF + type: object + BaseSuppression: + properties: + name: + description: The name of the suppression list + type: string + example: suppression-name + masks: + type: array + items: + type: string + example: '@example.com' + type: object + SuppressionDetails: + type: object + readOnly: true + allOf: + - $ref: '#/components/schemas/Suppression' + - $ref: '#/components/schemas/BaseSuppression' + SubscriptionConfirmationBody: + properties: + subscriptionConfirmationBodyId: + description: Subscription confirmation subject ID + type: string + example: asS1 + name: + description: Name + type: string + example: Database signup + contentPlain: + description: Plain text content equivalent of confirmation message + type: string + example: > + + Hello {{CONTACT \"subscriber_first_name\"}}, + \r\n \r\n{{INTERNAL \"body\"}}\r\n + + Your request to sign up to our\r\ndatabase has been received + and\r\nrequires your confirmation.\r\n\r\n + + EASY 1-CLICK CONFIRMATION:\r\n{{LINK \"confirm\"}}\r\n\r\nYou will + be added to the database\r\n + + instantly upon your confirmation.\r\n\r\n\r\nYou will be able to + unsubscribe\r\nor change your details at any time.\r\n\r\n + + If you have received this email in\r\nerror and did not intend to + join\r\nour database, no further action is\r\n + + required on your part.\r\n\r\nYou won't receive + further\r\ninformation and you won't be\r\n + + subscribed to any list until you\r\nconfirm your request + above.\r\n\r\n{{INTERNAL \"signature\"}} + contentHtml: + description: HTML content of confirmation message + type: string + example: '[HTML_CODE]' + type: object + SubscriptionConfirmationSubject: + properties: + subscriptionConfirmationSubjectId: + description: Subscription confirmation subject ID + type: string + example: AS3A + subject: + description: Subject + type: string + example: Action Requested - please confirm your subscription. + isPrivate: + $ref: '#/components/schemas/StringBooleanEnum' + type: object + x-konfig-properties: + isPrivate: + description: Is private + example: 'false' + PopupGeneralPerformanceStats: + required: + - popupId + properties: + popupId: + description: The form or popup ID + type: string + example: 7189c47e-e45f-4c45-a882-08649c48ff96 + views: + description: The total number of times your popup was viewed by website visitors + type: integer + format: int64 + example: 9 + clicks: + description: The number of clicks + type: integer + format: int64 + example: 2 + ctr: + description: >- + The number of clicks divided by the number of views, shown as a + percentage + type: integer + format: int64 + example: 5 + leads: + description: The number of leads + type: integer + format: int64 + example: 2 + type: object + PopupDetails: + properties: + popupId: + description: The form or popup ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/popups/ce84fabc-1349-4992-a2d7-0c44c5534128 + name: + description: The form or popup name + type: string + example: My popup name + status: + description: The form or popup status + type: string + enum: + - published + - unpublished + readOnly: true + type: + description: The form or popup type + type: string + enum: + - popup + - inline + readOnly: true + thumbnailUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://us-wbe-img2.gr-cdn.com/user/X/Y.webp + createdAt: + description: >- + The date the form or popup was created. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-01T10:35:00`. + type: string + format: date-time + example: '2024-01-01T10:35:00' + updatedAt: + description: >- + The date the form or popup was updated. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-10T10:00:00`. + type: string + format: date-time + example: '2024-01-10T10:00:00' + type: object + PopupListItem: + properties: + popupId: + description: The form or popup ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/popups/6b0d7d59-71d9-4708-80a6-aa0f13805111 + name: + description: The form or popup name + type: string + example: My popup name + status: + description: The form or popup status + type: string + enum: + - published + - unpublished + readOnly: true + type: + description: The form or popup type + type: string + enum: + - popup + - inline + readOnly: true + createdAt: + description: >- + The date the form or popup was created. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-01T10:35:00`. + type: string + format: date-time + updatedAt: + description: >- + The date the form or popup was updated. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-10T10:00:00`. + type: string + format: date-time + statistics: + description: The landing page statistics + $ref: '#/components/schemas/PopupListItemStatistics' + type: object + PopupListItemStatistics: + properties: + views: + description: The total number of times your popup was viewed by website visitors + type: integer + format: int64 + example: 9 + uniqueVisitors: + description: The total number of visitors + type: integer + format: int64 + example: 10 + leads: + description: The number of leads + type: integer + format: int64 + example: 5 + ctr: + description: >- + The number of clicks divided by the number of views, shown as a + percentage + type: integer + format: int64 + example: 52 + type: object + SplittestNewsletter: + properties: + newsletterId: + description: The newsletter ID + type: string + example: Z6e + href: + description: The direct newsletter URL + type: string + format: uri + example: https://api.getresponse.com/v3/newsletters/B2fvv + name: + description: The newsletter name + type: string + example: Newsletter name + subject: + description: The newsletter subject + type: string + example: Example subject + fromField: + description: The \"From\" address for the newsletter + type: object + $ref: '#/components/schemas/FromFieldReference' + status: + description: The status of the newsletter + type: string + enum: + - sampled + - chosen + - rejected + sendOn: + description: The date when the newsletter was sent + type: string + format: date-time + example: 2015-06-25T20:05:10+0000 + samplingTargets: + description: The newsletter sample targets + type: string + format: int32 + example: '2' + samplingDelivered: + description: The newsletter sample delivery + type: string + format: int32 + example: '2' + scoreOpens: + description: The newsletter open rate + type: string + format: int32 + example: '2' + scoreClicks: + description: The newsletter click rate + type: string + format: int32 + example: '2' + type: object + Splittest: + properties: + splittestId: + description: A/B test ID + type: string + example: A3r + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/splittests/A3r + name: + description: A/B test name + type: string + example: A/B test + campaign: + description: A/B test campaign + type: object + $ref: '#/components/schemas/CampaignReference' + status: + description: A/B test status + type: string + enum: + - active + - inactive + winningCriteria: + description: A/B test winning criteria + type: string + enum: + - open + - click + nullable: true + winningTarget: + description: A/B test wining target + type: string + format: int32 + example: '10' + stage: + description: A/B test stage + type: string + enum: + - queued + - schedule_sampling + - evaluate_sampling + - choose_winning + - schedule_winning + - send_winning + - canceled_queued + - canceled_sampling + - canceled_winning + - incomplete + - finished + type: + description: A/B test type + type: string + enum: + - content + - subject + - day + - hour + - from_field + samplingPercentage: + description: A/B test sample percentage + type: string + format: int32 + example: '18' + nullable: true + samplingTime: + description: A/B test sampling time in seconds + type: string + format: int32 + example: '86400' + nullable: true + chooseWinning: + description: The method of choosing the winning A/B test + type: string + enum: + - automatic + - manual + nullable: true + winningScoreOpens: + description: The open rate of the winning A/B test + type: string + format: int32 + example: '5' + winningScoreClicks: + description: The click rate of the winning A/B test + type: string + format: int32 + example: '3' + winningDelivered: + description: The delivery rate of the winning A/B test + type: string + format: int32 + example: '12' + winningScheduleOn: + description: The date for wchich the winning A/B test was scheduled + type: string + format: date-time + example: 2015-06-25T20:05:10+0000 + nullable: true + nextStepOn: + description: The date of the next step in the A/B test + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + evaluationSkippedOn: + description: The date when the A/B test was skipped + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + canceledOn: + description: The date when the A/B test was canceled + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + createdOn: + description: The date when the A/B test was created + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + newsletters: + description: The newsletters that are associated with the A/B test + type: array + items: + $ref: '#/components/schemas/SplittestNewsletter' + sendSettings: + description: The send settings for the A/B test + properties: + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSupressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + type: object + BaseFile: + properties: + name: + description: The file name + type: string + maxLength: 255 + minLength: 1 + example: image + extension: + description: The file extension + type: string + example: jpg + folder: + description: The folder where the file is stored + nullable: true + allOf: + - $ref: '#/components/schemas/FolderShort' + type: object + FileGroup: + description: The file group + type: string + enum: + - audio + - video + - photo + - document + example: photo + FolderShort: + required: + - folderId + properties: + folderId: + description: The folder ID + type: string + example: 4a9f + type: object + FileProperty: + required: + - name + - value + properties: + name: + type: string + enum: + - width + - height + readOnly: true + example: width + value: + readOnly: true + oneOf: + - type: integer + example: 1980 + - type: string + type: object + Quota: + properties: + limit: + description: The total size of available storage space + type: integer + format: int64 + example: 1048576 + usage: + description: The currently used storage space + type: integer + format: int64 + example: 1024 + type: object + Folder: + required: + - folderId + properties: + folderId: + description: The folder ID + type: string + readOnly: true + example: t1G + name: + description: The folder name + type: string + maxLength: 128 + minLength: 1 + example: sample folder + size: + description: The size of all files in the directory + type: integer + format: int64 + example: 9564899 + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + example: 2019-10-14T17:17:13+0000 + type: object + NewFolder: + required: + - name + properties: + name: + description: The folder name + type: string + maxLength: 128 + minLength: 1 + example: sample folder + type: object + AbtestsSubjectDetails: + type: object + allOf: + - $ref: '#/components/schemas/AbtestsSubjectListItem' + - properties: + winnerSendingStart: + description: Date the winning message was sent on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + statistics: + description: The statistics of A/B test + properties: + total: + type: object + $ref: '#/components/schemas/AbtestsSubjectStatistics' + winner: + type: object + $ref: '#/components/schemas/AbtestsSubjectStatistics' + type: object + readOnly: true + variants: + type: array + items: + properties: + variantId: + description: >- + The message variant ID. A variant identifier from + https://apireference.getresponse.com/#operation/getAbtestsSubjectById. + type: string + readOnly: true + example: VpKJdr + subject: + description: Variant's subject + type: string + maximum: 150 + minimum: 1 + example: variant + isWinner: + description: Winning variant + type: boolean + readOnly: true + example: true + statistics: + $ref: '#/components/schemas/AbtestsSubjectStatistics' + type: object + x-konfig-properties: + statistics: + description: Variant's statistics + type: object + readOnly: true + sendSettings: + description: The send settings for the A/B test + properties: + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSupressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + editor: + description: The message editor used for the A/B test + type: string + enum: + - html2 + - custom + - text + - editor_v3 + - getresponse + - legacy + nullable: true + content: + $ref: '#/components/schemas/MessageContent' + type: object + AbtestsSubjectStatistics: + properties: + delivered: + description: >- + The total number of delivered messages (winner and variants + combined) + type: integer + example: 10 + openRate: + description: The sum total of opens for the variants and the winner + type: integer + example: 8 + clickRate: + description: The message click rate + type: integer + example: 8 + type: object + AbtestsSubjectListItem: + type: object + allOf: + - $ref: '#/components/schemas/AbtestsSubject' + - properties: + status: + description: Newsletter status + type: string + enum: + - active + - inactive + - deleted + readOnly: true + stage: + description: A/B test stage + type: string + enum: + - preparing + - testing + - finished + - sending_winner + - cancelled + - draft + - completed + readOnly: true + deliverySettings: + description: The A/B test delivery settings + properties: + sendOn: + description: Date the newsletter was sent on + properties: + date: + description: Date the newsletter was sent on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + timeZone: + description: Time zone in which the newsletter was sent + properties: + timeZoneId: + description: ID of the time zone the newsletter was sent in + type: integer + timeZoneName: + description: Name of the time zone the newsletter was sent in + type: integer + nullable: true + timeZoneOffset: + description: >- + Time zone, or UTC, offset for when the newsletter + was sent + type: integer + nullable: true + type: object + type: object + winnerMode: + description: A/B test winner selection mode + type: string + enum: + - automatic + - manual + winningCriteria: + description: A/B test winning criteria + type: string + enum: + - open + - click + samplingPercentage: + description: Size of the test (sampling) group, expressed as a percentage + type: integer + format: int32 + maximum: 50 + minimum: 1 + samplingTime: + description: >- + A/B testing phase duration. The time after which the + remaining recipients will be sent the winning message + type: string + format: ISO-8601 duration + example: '86400' + nullable: true + type: object + flags: + type: array + items: + description: Tracking options enabled for the newsletter + type: string + enum: + - clicktrack + - subscription_reminder + - openrate + - google_analytics + - manual_list + - custom_footer + - ecommerce_tracking + readOnly: true + createdOn: + description: Date the A/B test was created on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + updatedOn: + description: Date A/B test was updated on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/ab-tests/subject/A3r + type: object + AbtestsSubject: + properties: + abTestId: + description: A/B test ID + type: string + readOnly: true + example: A3r + name: + description: A/B test name + type: string + maxLength: 100 + minLength: 1 + example: A/B test + campaign: + description: List linked to A/B test + properties: + campaignId: + description: Campaign ID + type: string + example: C + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/campaigns/C + name: + description: The campaign name + type: string + readOnly: true + example: Promo campaign + nullable: true + type: object + fromField: + description: Newsletter's From" address" + properties: + fromFieldId: + description: The 'From' address ID + type: string + example: V + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/V + type: object + replyTo: + description: Newsletter's reply-to address + properties: + fromFieldId: + description: The 'From' address ID + type: string + example: V + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/V + type: object + type: object + NewAbtestsSubject: + required: + - name + - href + type: object + allOf: + - required: + - name + - campaign + - fromField + properties: + abTestId: + description: A/B test ID + type: string + readOnly: true + example: A3r + name: + description: A/B test name + type: string + maxLength: 100 + minLength: 1 + example: A/B test + campaign: + description: List linked to A/B test + type: object + $ref: '#/components/schemas/CampaignReference' + fromField: + description: Newsletter's From" address" + type: object + $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: Newsletter's reply-to address + type: object + $ref: '#/components/schemas/FromFieldReference' + type: object + - required: + - deliverySettings + - variants + - sendSettings + - content + properties: + deliverySettings: + description: The A/B test delivery settings + required: + - samplingTime + - winningCriteria + - winnerMode + - sendOn + properties: + sendOn: + description: Date the newsletter was sent on + required: + - sendingType + properties: + sendingType: + description: >- + Newsletter send type. Please note that date and timezone + are not allowed with the 'now' option + type: string + enum: + - now + - scheduled + example: scheduled + date: + description: Date the newsletter was sent on + type: string + format: Y-m-d H:i:s + example: '2015-07-25T20:05:10' + nullable: true + timeZone: + description: Time zone in which the newsletter was sent + required: + - date + - timeZoneId + properties: + timeZoneId: + description: ID of the time zone the newsletter was sent in + type: integer + example: 285 + type: object + type: object + winnerMode: + description: A/B test winner selection mode + type: string + enum: + - automatic + - manual + winningCriteria: + description: A/B test winning criteria + type: string + enum: + - open + - click + samplingPercentage: + description: Size of the test (sampling) group, expressed as a percentage + type: integer + format: int32 + maximum: 50 + minimum: 1 + samplingTime: + description: >- + A/B testing phase duration. The time after which the + remaining recipients will be sent the winning message + type: string + format: ISO-8601 duration + example: P0Y0M0DT5H30M0S + nullable: true + type: object + flags: + type: array + items: + description: Tracking options enabled for the newsletter + type: string + enum: + - clicktrack + - google_analytics + - ecommerce_tracking + variants: + description: >- + Message variants. Please note, the number of subject variants + should be between 2 and 5 + required: + - subject + type: array + items: + properties: + subject: + description: Variant's subject + type: string + maximum: 150 + minimum: 1 + example: variant + type: object + sendSettings: + description: The send settings for the A/B test + properties: + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSupressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + content: + $ref: '#/components/schemas/MessageContent' + type: object + ChooseWinnerAbtestsSubject: + required: + - variantId + properties: + variantId: + description: >- + The message variant ID. A variant identifier from + https://apireference.getresponse.com/#operation/getAbtestsSubjectById. + type: string + example: VpKJdr + type: object + ClickTrackResource: + properties: + clickTrackId: + type: string + example: C12t + name: + description: The name (label) of a click track + type: string + example: Click here + url: + description: The link URL of a click track + type: string + format: uri + example: https://example.com/shop + clicks: + description: The number of clicks counted for a click track + type: integer + format: int64 + example: 25951 + message: + type: object + $ref: '#/components/schemas/ClickTrackMessage' + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/click-tracks/C12t + type: object + ClickTrackMessage: + description: The source message reference for a click track + properties: + resourceId: + description: The ID identifying message resource + type: string + example: r35N + type: + description: The message type + type: string + enum: + - broadcast + - automation + - autoresponder + - rss + - splittest + - sms + example: broadcast + createdOn: + description: The message creation date + type: string + format: date-time + example: 2019-12-01T08:21:28+0000 + resourceType: + description: Type of the resource that represents the message in the API + type: string + enum: + - newsletters + - autoresponders + - rss-newsletters + - splittests + - sms + example: newsletters + href: + description: Direct URL to the resource that represents the message + type: string + format: uri + example: https://api.getresponse.com/v3/newsletters/r35N + type: object + MessageStatisticsListElement: + properties: + timeInterval: + description: >- + The statistics time frame in the ISO 8601 datetime format with + duration interval + type: string + pattern: >- + /^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?(\/)P(?=\w*\d)(?:\d+Y|Y)?(?:\d+M|M)?(?:\d+W|W)?(?:\d+D|D)?(?:T(?:\d+H|H)?(?:\d+M|M)?(?:\d+(?:\­.\d{1,2})?S|S)?)?$/ + example: 2014-09-20T00:00:00+0000/P2M18DT10H0M0S + sent: + type: integer + format: int32 + totalOpened: + type: integer + format: int32 + uniqueOpened: + type: integer + format: int32 + totalClicked: + type: integer + format: int32 + uniqueClicked: + type: integer + format: int32 + goals: + type: integer + format: int32 + uniqueGoals: + type: integer + format: int32 + forwarded: + type: integer + format: int32 + unsubscribed: + type: integer + format: int32 + bounced: + type: integer + format: int32 + complaints: + type: integer + format: int32 + type: object + SendNewsletterDraft: + required: + - messageId + - sendSettings + properties: + messageId: + description: The message identifier (equals to newsletterId) + type: string + example: 'N' + sendOn: + description: >- + The scheduled send date for the message in the ISO 8601 format. + **Please note:** To send your message immediately, omit the `sendOn` + section + type: string + format: date-time + sendSettings: + $ref: '#/components/schemas/NewsletterSendSettingsDetails' + type: object + x-konfig-properties: + sendSettings: + description: How the message will be delivered to the subscriber + NewsletterAttachment: + properties: + fileName: + description: The file name + type: string + example: some_file.jpg + content: + description: The base64 encoded file content + type: string + format: byte + example: sdfadsfetsdjfdskafdsaf== + mimeType: + description: The file mime type + type: string + example: image/jpeg + type: object + ExternalLexpad: + description: >- + External Lexpad settings for the message, read more: [External + Lexpad](https://apidocs.getresponse.com/v3/dynamic-content/external-lexpad) + required: + - dataSourceUrl + properties: + dataSourceUrl: + description: URL to the endpoint that will provide data for External Lexpad + type: string + format: uri + maxLength: 2048 + minLength: 1 + example: https://example.com/external_lexpad + dataSourceToken: + description: >- + Token that will be sent in `X-Auth-Token` header to authenticate the + requests made to the endpoint + type: string + maxLength: 255 + minLength: 0 + example: cf4dfca78434bf927a7655c0c4d95a2a45c33b71 + nullable: true + type: object + NewsletterSendSettingsDetails: + properties: + selectedCampaigns: + description: The list of selected campaigns + items: + type: string + example: V + selectedSegments: + description: The list of selected segments + items: + type: string + example: S + selectedSuppressions: + description: The list of selected suppressions (suppressions exclude contacts) + items: + type: string + example: Se + excludedCampaigns: + description: The list of excluded campaigns + items: + type: string + example: O + excludedSegments: + description: The list of excluded segments + items: + type: string + example: R + selectedContacts: + description: The list of selected contacts + items: + type: string + example: Qs + timeTravel: + $ref: '#/components/schemas/StringBooleanEnum' + perfectTiming: + $ref: '#/components/schemas/StringBooleanEnum' + externalLexpad: + description: >- + External Lexpad settings for the message, read more: [External + Lexpad](https://apidocs.getresponse.com/v3/dynamic-content/external-lexpad) + nullable: true + allOf: + - $ref: '#/components/schemas/ExternalLexpad' + type: object + x-konfig-properties: + timeTravel: + description: >- + Use the time travel functionality. This means that the system will + match the scheduled sending hour for the message to the time zone of + each recipient. As a result, sending may take up to 24 hours. + example: 'true' + perfectTiming: + description: Use the perfect timing functionality + example: 'false' + Newsletter: + required: + - newsletterId + - href + properties: + newsletterId: + description: The newsletter ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/newsletters/N + name: + description: The newsletter name + type: string + maxLength: 128 + minLength: 2 + example: New message + type: + description: The newsletter type + type: string + default: broadcast + enum: + - broadcast + - draft + status: + $ref: '#/components/schemas/StatusEnum' + editor: + $ref: '#/components/schemas/MessageEditorEnum' + subject: + description: The message subject + type: string + maxLength: 128 + minLength: 2 + example: Annual report + fromField: + $ref: '#/components/schemas/FromFieldReference' + replyTo: + $ref: '#/components/schemas/FromFieldReference' + campaign: + $ref: '#/components/schemas/CampaignReference' + sendOn: + description: >- + The scheduled send date and time for the newsletter in the ISO 8601 + format. + type: string + format: date-time + readOnly: true + attachments: + description: >- + The newsletter attachments. The size of all attachments combined + can't exceed 400KB + type: array + items: + $ref: '#/components/schemas/NewsletterAttachment' + sendSettings: + $ref: '#/components/schemas/NewsletterSendSettingsDetails' + sendMetrics: + description: The sending metrics + type: object + readOnly: true + allOf: + - properties: + status: + type: string + default: finished + enum: + - scheduled + - in_progress + - finished + sent: + description: Messages already sent + type: string + default: '0' + total: + description: The total amount of messages to send + type: string + default: '0' + type: object + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + x-konfig-properties: + status: + description: The newsletter status + readOnly: true + example: enabled + editor: + description: This describes how the content of the message was created + fromField: + description: The 'From' email address used for the message + replyTo: + description: The email that will be used as the reply-to address + campaign: + description: The newsletter must be assigned to a campaign + sendSettings: + description: >- + How the message will be delivered to the subscriber. You can specify + multiple parameters. Then the system uses AND logic. + NewNewsletter: + required: + - subject + - fromField + - campaign + - content + - sendSettings + properties: + content: + $ref: '#/components/schemas/MessageContent' + flags: + $ref: '#/components/schemas/MessageFlagsArray' + name: + description: The newsletter name + type: string + maxLength: 128 + minLength: 2 + example: New message + type: + description: The newsletter type + type: string + default: broadcast + enum: + - broadcast + - draft + editor: + $ref: '#/components/schemas/MessageEditorEnum' + subject: + description: The message subject + type: string + maxLength: 128 + minLength: 2 + example: Annual report + fromField: + $ref: '#/components/schemas/FromFieldReference' + replyTo: + $ref: '#/components/schemas/FromFieldReference' + campaign: + $ref: '#/components/schemas/CampaignReference' + sendOn: + description: >- + The scheduled send date and time for the newsletter in the ISO 8601 + format. **Please note:** To send your message immediately, omit the + `sendOn` section + type: string + format: date-time + attachments: + description: >- + The newsletter attachments. The size of all attachments combined + can't exceed 400KB + type: array + items: + $ref: '#/components/schemas/NewsletterAttachment' + sendSettings: + $ref: '#/components/schemas/NewsletterSendSettingsDetails' + type: object + x-konfig-properties: + editor: + description: This describes how the content of the message was created + fromField: + description: The 'From' email address used for the message + replyTo: + description: The email that will be used as the reply-to address + campaign: + description: The newsletter must be assigned to a campaign + sendSettings: + description: >- + How the message will be delivered to the subscriber. You can specify + multiple parameters. Then the system uses AND logic. + NewsletterListElement: + required: + - newsletterId + - href + properties: + newsletterId: + description: The newsletter ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/newsletters/N + name: + description: The newsletter name + type: string + maxLength: 128 + minLength: 2 + example: New message + type: + description: The newsletter type + type: string + default: broadcast + enum: + - broadcast + - draft + status: + $ref: '#/components/schemas/StatusEnum' + editor: + $ref: '#/components/schemas/MessageEditorEnum' + subject: + description: The message subject + type: string + maxLength: 128 + minLength: 2 + example: Annual report + campaign: + $ref: '#/components/schemas/CampaignReference' + sendOn: + description: >- + The scheduled send date and time for the newsletter in the ISO 8601 + format. + type: string + format: date-time + sendSettings: + $ref: '#/components/schemas/NewsletterSendSettingsListing' + sendMetrics: + description: The sending metrics + type: object + readOnly: true + allOf: + - properties: + status: + type: string + default: finished + enum: + - scheduled + - in_progress + - finished + sent: + description: Messages already sent + type: string + default: '0' + total: + description: The total amount of messages to send + type: string + default: '0' + type: object + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + flags: + $ref: '#/components/schemas/MessageFlagsString' + type: object + x-konfig-properties: + status: + description: The newsletter status + readOnly: true + example: enabled + editor: + description: This describes how the content of the message was created + campaign: + description: The newsletter must be assigned to a campaign + sendSettings: + description: >- + How the message will be delivered to the subscriber. You can specify + multiple parameters. Then the system uses AND logic. + NewsletterSendSettingsListing: + properties: + timeTravel: + $ref: '#/components/schemas/StringBooleanEnum' + perfectTiming: + $ref: '#/components/schemas/StringBooleanEnum' + type: object + x-konfig-properties: + timeTravel: + description: >- + Use the time travel functionality. This means that the system will + match the scheduled sending hour for the message to the time zone of + each recipient. As a result, sending may take up to 24 hours. + example: 'true' + perfectTiming: + description: Use the perfect timing functionality + example: 'false' + ClickTrack: + properties: + clickTrackId: + type: string + example: C + url: + description: The tracked link + type: string + format: uri + example: https://example.com + name: + description: The tracked link name + type: string + example: press here + amount: + description: The number of clicks on a link in a message + type: string + example: '15' + type: object + NewsletterActivity: + properties: + activity: + description: The type of activity + type: string + enum: + - send + - open + - click + createdOn: + description: The date when activity occurred + type: string + format: date-time + example: 2019-10-21T11:08:45+0000 + contact: + $ref: '#/components/schemas/NewsletterActivityContactReference' + type: object + x-konfig-properties: + contact: + description: The contact ID + NewsletterActivityContactReference: + properties: + contactId: + description: The contact ID + type: string + example: pV3r + email: + description: The contact email + type: string + example: contact@domain.com + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/contacts/pV3r + type: object + BaseTag: + properties: + name: + description: The tag name + type: string + maxLength: 255 + minLength: 2 + pattern: ^[_a-zA-Z0-9]{2,255}$ + example: My_Tag + color: + description: The tag color (deprecated) + type: string + readOnly: true + deprecated: true + type: object + Blocklist: + properties: + masks: + type: array + items: + type: string + example: jack@somedomain.com + type: object + CustomFieldReference: + required: + - customField + properties: + customFieldId: + type: string + readOnly: true + example: pas + name: + description: >- + + The name of the custom field. It must meet the following + requirements: + * be unique + * use only lowercase letters, underscores and digits: [a-z0-9_]{1,128} + * not be equal to one of the merge words used in messages, i.e. `name`, `email`, `twitter`, `facebook`, `buzz`, `myspace`, `linkedin`, `digg`, `googleplus`, `pinterest`, `responder`, `campaign`, `change`. + type: string + maxLength: 128 + minLength: 1 + example: color + values: + description: >- + The list of assigned default values, starting from zero depending on + the custom field type. (Please see description). + type: array + items: + type: string + example: red + type: object + Lps: + type: object + allOf: + - $ref: '#/components/schemas/LpsListItem' + - properties: + statistics: + description: The landing page statistics + $ref: '#/components/schemas/LpsListItemStatistics' + type: object + LpsListItem: + properties: + lpsId: + description: The landing page ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/lps/6b0d7d59-71d9-4708-80a6-aa0f13805111 + name: + description: The landing page name + type: string + example: 'Predesigned #017' + status: + description: The landing page status + type: string + enum: + - published + - unpublished + readOnly: true + domainUrl: + description: The landing page domain + type: string + format: uri + readOnly: true + example: predesigned-017-52612.grweb.site + thumbnailUrl: + description: The URL of a landing page thumbnail + type: string + format: uri + readOnly: true + example: >- + https://us-wbe-img2.gr-cdn.com/user/e5c2094a-2354-459f-9b9f-6d0369ccae2c/6b0d7d59-71d9-4708-80a6-aa0f13805111.png?width=208 + isChatsEnabled: + $ref: '#/components/schemas/StringBooleanEnum' + createdAt: + description: The date the landing page was created + type: string + format: date-time + updatedAt: + description: The date the landing page was updated + type: string + format: date-time + type: object + x-konfig-properties: + isChatsEnabled: + description: Chats is enabled on the landing page + example: true + LpsListItemStatistics: + properties: + visits: + description: The number of browsing sessions initiated on your landing page + type: integer + format: int64 + example: 9 + leads: + description: Number of leads + type: integer + format: int64 + example: 5 + subscriptionRate: + description: >- + The number of leads divided by the number of visitors, shown as a + percentage + type: integer + format: int64 + example: 52 + type: object + LpsDetails: + type: object + allOf: + - $ref: '#/components/schemas/LpsListItem' + - $ref: '#/components/schemas/LpsDetailsStatistics' + - properties: + pages: + type: array + items: + $ref: '#/components/schemas/LpsPage' + type: object + LpsDetailsStatistics: + properties: + pageViews: + description: The total number of times your landing page was viewed or refreshed + type: integer + format: int64 + example: 9 + visits: + description: The number of browsing sessions initiated on your landing page + type: integer + format: int64 + example: 5 + uniqueVisitors: + description: The number of people who visited your landing page + type: integer + format: int64 + example: 5 + type: object + LpsPage: + properties: + uuid: + description: >- + The ID of a page associated with the landing page (i.e., 404 page + and thank you page) + type: string + readOnly: true + example: 6ee7597f-9bde-4b92-9411-2fb228c9fa34 + name: + description: >- + The name of a page associated with the landing page (i.e., 404 page + and thank you page) + type: string + example: Home + status: + description: >- + The status of a page associated with the landing page (i.e., 404 + page or thank you page) + type: string + enum: + - active + - inactive + url: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: /terms-of-service + redirectUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: '' + createdAt: + description: >- + The date a page associated with the landing page (i.e., 404 page or + thank you page) was created + type: string + format: date-time + type: object + LpsStats: + required: + - lpsId + properties: + lpsId: + description: The landing page ID + type: string + example: 6ee7597f-9bde-4b92-9411-2fb228c9fa34 + name: + type: string + example: Some example landing page + pageViews: + description: The total number of times your landing page was viewed or refreshed + type: integer + format: int64 + example: 9 + visits: + description: The number of browsing sessions initiated on your landing page + type: integer + format: int64 + example: 5 + uniqueVisitors: + description: The number of people who visited your landing page + type: integer + format: int64 + example: 5 + thumbnailUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://us-wbe-img2.gr-cdn.com/user/X/Y.webp + type: object + ImageDetails: + properties: + imageId: + description: Image ID + type: string + example: '123456' + originalImageUrl: + description: URL from which image was downloaded + type: string + format: uri + example: http://somesite.example.com/my_image.jpg + nullable: true + size: + description: Size in bytes + type: string + example: '1234567' + name: + description: Original name + type: string + example: original_image + thumbnailUrl: + description: Thumbnail URL + type: string + format: uri + example: >- + https://us-re.gr-cdn.com/114x/https://multimedia.getresponse.com/getresponse-hUXzv/photos/123456.jpg + url: + description: Asset URL + type: string + format: uri + example: >- + https://multimedia.getresponse.com/getresponse-hUXzv/photos/123456.jpg + extension: + description: File extension + type: string + enum: + - jpg + - gif + - png + - jpeg + - bmp + example: jpg + type: object + CreateMultimedia: + properties: + file: + type: string + format: binary + type: object + Tracking: + properties: + grid: + type: string + readOnly: true + example: 2fEBK5kj4ReCxUvd + snippet: + type: string + readOnly: true + example: >- + + snippetV2: + type: string + readOnly: true + example: + type: object + FacebookPixel: + properties: + name: + type: string + readOnly: true + example: integration-pixel + pixelId: + type: string + readOnly: true + example: '123' + type: object + StatusEnum: + type: string + enum: + - enabled + - disabled + StringBooleanEnum: + type: string + enum: + - 'true' + - 'false' + SortOrderEnum: + type: string + enum: + - ASC + - DESC + DateOrDateTime: + oneOf: + - type: string + format: date + example: '2018-04-15' + - type: string + format: date-time + example: 2018-01-15T13:30:42+0000 + ErrorResponse: + required: + - httpStatus + - code + - codeDescription + - message + - moreInfo + - context + - uuid + properties: + httpStatus: + description: HTTP response code + type: integer + format: int32 + code: + description: API error code + type: integer + format: int32 + codeDescription: + description: API error code description + type: string + message: + description: Error message + type: string + moreInfo: + description: URL to error description in the API Docs + type: string + context: + type: array + items: + type: string + uuid: + description: UUID of the error response + type: string + type: object + AccountBadgeDetails: + properties: + status: + description: Current badge status + example: enabled + $ref: '#/components/schemas/StatusEnum' + type: object + SendingLimitsListItem: + properties: + timeFrame: + description: Time frame, measured in seconds + type: integer + example: 2592000 + limit: + description: The number of email sends available within a given time frame + type: integer + example: 2500 + used: + description: The number of email sends used within the given time frame + type: integer + example: 0 + type: object + IndustryTagId: + properties: + industryTagId: + description: Industry tag ID + type: string + format: integer + example: '1' + type: object + IndustryTagProperties: + properties: + description: + type: string + readOnly: true + example: Marketing agencies big and small, with fluent and wise agents... + name: + type: string + readOnly: true + example: Marketing agencies + type: object + IndustryTag: + required: + - industryTagId + type: object + allOf: + - $ref: '#/components/schemas/IndustryTagId' + - $ref: '#/components/schemas/IndustryTagProperties' + TimezoneName: + properties: + name: + description: >- + Time zone name as defined by + https://en.wikipedia.org/wiki/List_of_tz_database_time_zones + type: string + example: Europe/Warsaw + type: object + TimezoneOffset: + properties: + offset: + type: string + pattern: /^(?:Z|[+-](?:2[0-3]|[01][0-9]):[0-5][0-9])$/ + example: '+01:00' + type: object + TimezoneId: + properties: + timezoneId: + type: integer + format: int32 + example: 1 + type: object + TimezoneCountry: + properties: + country: + type: string + example: Poland + type: object + Timezone: + required: + - timezoneId + allOf: + - $ref: '#/components/schemas/TimezoneId' + - $ref: '#/components/schemas/TimezoneName' + - $ref: '#/components/schemas/TimezoneOffset' + - $ref: '#/components/schemas/TimezoneCountry' + AccountsLoginHistoryListElement: + properties: + loginTime: + description: Login time + type: string + format: date-time + example: 2004-02-12T15:19:21+0000 + logoutTime: + description: Logout time + type: string + format: date-time + example: 2004-02-12T15:19:21+0000 + nullable: true + isSuccessful: + $ref: '#/components/schemas/StringBooleanEnum' + ip: + description: IP address + type: string + format: ipv4 + example: 192.0.0.1 + type: object + x-konfig-properties: + isSuccessful: + description: Login was successful + example: 'true' + CallbackActions: + properties: + open: + description: Is `open` callback enabled + type: boolean + click: + description: Is `click` callback enabled + type: boolean + goal: + description: Is `goal` callback enabled + type: boolean + subscribe: + description: Is `subscribe` callback enabled + type: boolean + unsubscribe: + description: Is `unsubscribe` callback enabled + type: boolean + survey: + description: Is `survey` callback enabled + type: boolean + type: object + Callback: + properties: + url: + description: URL to use to post notifications + format: uri + actions: + $ref: '#/components/schemas/CallbackActions' + type: object + AccountDetailsCountryCode: + properties: + countryCodeId: + description: Country code ID + type: string + example: '175' + countryCode: + description: Country code + type: string + example: PL + type: object + AccountBilling: + properties: + listSize: + description: Billing plan maximum list size + type: string + example: '2500' + paymentPlan: + description: Payment plan + type: string + enum: + - Free Trial + - Monthly + - 12 Months + - 24 Months + example: Monthly + subscriptionPrice: + description: Subscription price + type: integer + example: 25 + renewalDate: + description: Subscription reneval date + type: string + format: date + example: '2017-01-01' + currencyCode: + description: Currency code compliant with ISO-4217 + type: string + example: USD + accountBalance: + description: Account balance + type: string + example: '-15.00' + price: + description: Price + type: integer + example: 25 + paymentMethod: + description: Payment method + type: string + enum: + - outside_system + - inside_system + - credit_card + - platnosci_pl + - direct_debit + - paypal + - yandex + - alipay + - alipay_mobile + - boleto + - ideal + - qiwi + - sofort + - webmoney + example: credit_card + creditCard: + type: object + nullable: true + allOf: + - properties: + number: + description: Masked credit card number + type: string + example: XXXXXXXXX0123 + type: object + - properties: + expirationDate: + description: Expiration date + type: string + format: date + example: '2014-01-01' + type: object + addons: + description: Addons + type: array + items: + properties: + name: + description: Addon name + type: string + example: Landing Page Creator + price: + description: Addon price + type: integer + example: 15 + active: + $ref: '#/components/schemas/StringBooleanEnum' + type: object + x-konfig-properties: + active: + description: Addon active status + example: 'true' + type: object + SubscriptionsByDatesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignSubscriptionStatisticsList' + CampaignSubscriptionStatisticsList: + description: Dates in the YYYY-MM-DD format are used as keys. + type: object + example: + '2014-12-15': + V: + summary: 99 + import: 10 + email: 11 + www: 10 + panel: 14 + leads: 3 + sale: 3 + api: 1 + forward: 15 + survey: 6 + mobile: 12 + copy: 7 + landing_page: 4 + p: + summary: 93 + import: 9 + email: 7 + www: 9 + panel: 5 + leads: 3 + sale: 3 + api: 8 + forward: 10 + survey: 8 + mobile: 10 + copy: 10 + landing_page: 7 + additionalProperties: + $ref: '#/components/schemas/CampaignSubscriptionStatisticsItemByCampaign' + CampaignRemovalsStatisticsItem: + type: object + anyOf: + - properties: + api: + type: integer + example: 1 + type: object + - properties: + automation: + type: integer + example: 1 + type: object + - properties: + blacklisted: + type: integer + example: 1 + type: object + - properties: + bounce: + type: integer + example: 1 + type: object + - properties: + cleaner: + type: integer + example: 1 + type: object + - properties: + compliant: + type: integer + example: 1 + type: object + - properties: + support: + type: integer + example: 1 + type: object + - properties: + unsubscribe: + type: integer + example: 1 + type: object + - properties: + user: + type: integer + example: 1 + type: object + CampaignSubscriptionStatisticsItemByCampaign: + description: The properties of the result are indexed with the campaign ID. + type: object + example: + V: + summary: 99 + import: 10 + email: 11 + www: 10 + panel: 14 + leads: 3 + sale: 3 + api: 1 + forward: 15 + survey: 6 + mobile: 12 + copy: 7 + landing_page: 4 + webinar: 3 + p: + summary: 93 + import: 9 + email: 7 + www: 9 + panel: 5 + leads: 3 + sale: 3 + api: 8 + forward: 10 + survey: 8 + mobile: 10 + copy: 10 + landing_page: 7 + webinar: 4 + additionalProperties: + description: The properties of the result are indexed with the campaign ID + $ref: '#/components/schemas/CampaignSubscriptionStatisticsItem' + CampaignSubscriptionStatisticsItem: + properties: + summary: + type: integer + example: 0 + import: + type: integer + example: 0 + email: + type: integer + example: 0 + www: + type: integer + example: 0 + panel: + type: integer + example: 0 + leads: + type: integer + example: 0 + sale: + type: integer + example: 0 + api: + type: integer + example: 0 + forward: + type: integer + example: 0 + survey: + type: integer + example: 0 + mobile: + type: integer + example: 0 + copy: + type: integer + example: 0 + landing_page: + type: integer + example: 0 + webinar: + type: integer + example: 0 + type: object + CampaignSummaryList: + type: array + items: + $ref: '#/components/schemas/CampaignSummaryItem' + CampaignLocationsList: + type: array + items: + $ref: '#/components/schemas/CampaignLocationItem' + RemovalsByDatesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignRemovalsStatisticsList' + CampaignRemovalsStatisticsList: + type: object + example: + '2014-12-05': + user: 5 + '2015-01-22': + user: 12 + bounce: 2 + additionalProperties: + description: Dates in YYYY-MM-DD format are used as keys + $ref: '#/components/schemas/CampaignRemovalsStatisticsItem' + CampaignLocationItem: + type: object + example: + others: + amount: '6' + continentCode: '' + countryCode: '' + PL: + amount: '45' + continentCode: EU + countryCode: PL + additionalProperties: + description: The results are indexed with the location name (PL, EN, etc.) + properties: + amount: + description: The amount of subscribers from a given location + type: string + format: number + example: '0' + continentalCode: + description: The region code + type: string + example: EU + countryCode: + description: The country code + type: string + example: PL + type: object + CampaignOriginsList: + type: array + items: + $ref: '#/components/schemas/CampaignSubscriptionStatisticsItemByCampaign' + CampaignListSizesStatisticsElement: + properties: + totalSubscribers: + description: The total amount of subscribers for a given datetime and grouping + type: integer + format: int64 + addedSubscribers: + description: The amount of subscribers added since the previous statistics frame + type: integer + format: int64 + removedSubscribers: + description: >- + The amount of subscribers removed since the previous statistics + frame + type: integer + format: int64 + createdOn: + description: >- + The statistics frame timestamp. The value depends on the groupBy + parameter. For the hour, use datetime in the format YYYY-mm-dd + HH:mm:ss; for the day, use date in the format YYYY-mm-dd; for the + month, use a string in the format YYYY-mm; and for the total, use + the string total. + type: string + type: object + CampaignListSizesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignListSizesStatisticsElement' + BalanceByDatesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignBalanceStatisticsList' + CampaignBalanceStatisticsList: + type: object + example: + '2014-12-05': + removals: + user: 5 + subscriptions: + summary: 7 + import: 0 + email: 0 + www: 0 + panel: 0 + leads: 0 + sale: 0 + api: 7 + forward: 0 + survey: 0 + mobile: 0 + copy: 0 + landing_page: 0 + '2015-01-21': + removals: + user: 10 + additionalProperties: + description: Dates in YYYY-MM-DD format are used as keys + anyOf: + - properties: + removals: + $ref: '#/components/schemas/CampaignRemovalsStatisticsItem' + type: object + x-konfig-properties: + removals: + type: object + - properties: + subscriptions: + $ref: '#/components/schemas/CampaignSubscriptionStatisticsItem' + type: object + x-konfig-properties: + subscriptions: + type: object + CampaignSummaryItem: + description: >- + The properties of the result are indexed with the location name (PL, EN, + etc.). + type: object + example: + o5lx: + totalSubscribers: '4' + totalNewsletters: '129' + totalTriggers: '0' + totalLandingPages: '1' + totalWebforms: '3' + CC9F: + totalSubscribers: '0' + totalNewsletters: '0' + totalTriggers: '0' + totalLandingPages: '5' + totalWebforms: '0' + V6OeR: + totalSubscribers: '0' + totalNewsletters: '0' + totalTriggers: '0' + totalLandingPages: '0' + totalWebforms: '0' + additionalProperties: + properties: + totalSubscribers: + description: The total number of subscribers + type: string + format: number + example: '0' + totalNewsletters: + description: The total number of newsletters + type: string + format: number + example: '0' + totalTriggers: + description: The total number of triggers + type: string + format: number + example: '0' + totalLandingPages: + description: The total number of landing pages + type: string + format: number + example: '0' + totalWebforms: + description: The total number of webforms + type: string + format: number + example: '0' + type: object + CampaignReference: + required: + - campaignId + properties: + campaignId: + description: Campaign ID + type: string + example: C + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/campaigns/C + name: + description: The campaign name + type: string + readOnly: true + example: Promo campaign + nullable: true + type: object + CampaignStatisticsIdQuery: + type: string + example: 3Va2e + LegacyForm: + properties: + webformId: + description: The webform (Legacy Form) ID + type: string + example: NPKx + name: + type: string + example: Webform 2010/7/5 + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/webforms/NPKx + scriptUrl: + description: The URL of the script that displays the Legacy Form + type: string + format: uri + example: https://app.getresponse.com/view_webform.js?u=VfEy1&wid=11774901 + status: + $ref: '#/components/schemas/StatusEnum' + modifiedOn: + description: The modification date + type: string + format: date-time + statistics: + $ref: '#/components/schemas/LegacyFormStatistics' + campaign: + $ref: '#/components/schemas/CampaignReference' + type: object + LegacyFormStatistics: + properties: + opened: + description: The number of Legacy Form views + type: integer + format: int64 + example: 1234 + subscribed: + description: The number of contacts that subscribed using this Legacy Form + type: integer + format: int64 + example: 100 + type: object + GDPRField: + properties: + gdprFieldId: + type: string + readOnly: true + example: MtY + name: + description: The name of the GDPR field + type: string + example: 'Consent #1' + createdOn: + type: string + format: date-time + example: 2018-08-01T09:18:00+0000 + href: + description: The direct hyperlink to the resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/gdpr-fields/MtY + type: object + GDPRFieldLatestVersion: + properties: + gdprFieldVersionId: + type: string + readOnly: true + example: yRI + content: + description: The content of the GDPR field + type: string + readOnly: true + example: '1st version of Consent #1' + createdOn: + type: string + format: date-time + example: 2018-08-02T11:12:00+0000 + type: object + GDPRFieldDetails: + type: object + allOf: + - $ref: '#/components/schemas/GDPRField' + - properties: + latestVersion: + $ref: '#/components/schemas/GDPRFieldLatestVersion' + type: object + UpdateWorkflow: + required: + - status + properties: + status: + description: >- + An 'incomplete' status means that the workflow is a 'draft' in the + web panel + type: string + enum: + - active + - inactive + - incomplete + example: active + type: object + Workflow: + required: + - workflowId + - name + - status + - subscriberStatistics + properties: + workflowId: + description: The workflow ID + type: string + readOnly: true + example: pxs + name: + type: string + example: My draft + status: + type: string + enum: + - active + - inactive + - incomplete + example: active + dateStart: + type: string + format: date-time + example: 2014-02-12T15:19:21+0000 + dateStop: + type: string + format: date-time + example: 2014-04-12T15:19:21+0000 + subscriberStatistics: + $ref: '#/components/schemas/WorkflowSubscriberStatistics' + type: object + WorkflowSubscriberStatistics: + required: + - completedCount + - inProgressCount + properties: + completedCount: + description: The number of subscribers that completed the workflow + type: integer + format: int64 + readOnly: true + example: 4 + inProgressCount: + description: The number of subscribers that are in progress in the workflow + type: integer + format: int64 + readOnly: true + example: 3 + type: object + SmsAutomationListItem: + required: + - smsId + properties: + smsId: + description: The automated SMS message ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/sms-automation/N + name: + description: The automated SMS message name + type: string + maxLength: 128 + minLength: 2 + example: New message + campaign: + $ref: '#/components/schemas/CampaignReference' + modifiedOn: + description: >- + The date the automated SMS message was last modified on, shown in + `ISO 8601` date and time format. e.g. `2022-04-10T10:02:57+0000` + type: string + format: date-time + status: + description: The status of of the automated SMS message + type: string + enum: + - ready + - in_use + statistics: + description: Automate SMS message statistics + allOf: + - properties: + sent: + description: The number od sent automated SMS messages + type: integer + example: 12 + delivered: + description: The number of delivered automated SMS messages + type: integer + example: 10 + clicks: + description: The number of automated SMS link clicks + type: integer + example: 8 + type: object + senderName: + description: The name of the sender of the automated SMS message + type: string + readOnly: true + hasLinks: + description: Information is the automated SMS message contains links + type: boolean + readOnly: true + type: object + x-konfig-properties: + campaign: + description: The campaign the SMS message is in + SmsListItem: + required: + - newsletterId + - href + properties: + smsId: + description: The SMS message ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/sms/N + name: + description: The SMS message name + type: string + maxLength: 128 + minLength: 2 + example: New message + campaign: + $ref: '#/components/schemas/CampaignReference' + modifiedOn: + description: >- + The date the SMS message was last modified on, shown in `ISO 8601` + date and time format. e.g. `2022-04-10T10:02:57+0000` + type: string + format: date-time + type: + description: The SMS message type + type: string + enum: + - sms + - draft + readOnly: true + sendOn: + description: SMS message send date details + type: object + nullable: true + allOf: + - properties: + date: + description: >- + Send date. Shown in format `ISO 8601` without timezone + offset e.g. `2022-04-10T10:02:57`. + type: string + format: date-time + example: '2022-03-26T10:35:00' + timeZone: + description: Time zone details + type: object + allOf: + - properties: + timeZoneId: + description: Time zone ID + type: integer + example: 123 + timeZoneName: + description: Time zone name + type: string + example: America/New_York + timeZoneOffset: + description: Time zone offset + type: string + example: '-05:00' + type: object + type: object + recipientsType: + description: Type of SMS message recipients + type: string + enum: + - contacts + - importedNumbers + readOnly: true + example: contacts + senderName: + description: The SMS message sender name + type: string + readOnly: true + content: + description: The SMS message content + type: string + example: This is my SMS content + sendMetrics: + description: Information about sending process + type: object + allOf: + - properties: + progress: + description: Sending progress + type: string + status: + description: Sending status + type: string + enum: + - scheduled + - sending + - sent + type: object + statistics: + description: Message statistics + allOf: + - properties: + sent: + description: Number of sent messages + type: integer + example: 12 + delivered: + description: Number of delivered messages + type: integer + example: 10 + clicks: + description: Number of clicked messages + type: integer + example: 8 + type: object + type: object + x-konfig-properties: + campaign: + description: The SMS message campaign + AutoresponderList: + type: array + items: + $ref: '#/components/schemas/Autoresponder' + Website: + properties: + websiteId: + description: The website ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/websites/6b0d7d59-71d9-4708-80a6-aa0f13805111 + name: + description: The website name + type: string + example: 'Predesigned #017' + status: + description: The website status + type: string + enum: + - published + - unpublished + readOnly: true + domainUrl: + description: The website domain + type: string + format: uri + readOnly: true + example: predesigned-017-52612.grweb.site + thumbnailUrl: + description: The URL of a website thumbnail + type: string + format: uri + readOnly: true + example: >- + https://us-wbe-img2.gr-cdn.com/user/e5c2094a-2354-459f-9b9f-6d0369ccae2c/6b0d7d59-71d9-4708-80a6-aa0f13805111.png?width=208 + isChatsEnabled: + $ref: '#/components/schemas/StringBooleanEnum' + createdAt: + description: The date the website was created + type: string + format: date-time + updatedAt: + description: The date the website was updated + type: string + format: date-time + statistics: + description: The website statistics + $ref: '#/components/schemas/WebsiteStatistics' + type: object + x-konfig-properties: + isChatsEnabled: + description: Chats is enabled on the website + example: true + WebsiteStatistics: + properties: + pageViews: + description: Number of page views + type: integer + format: int64 + example: 9 + visits: + description: Number of site visits + type: integer + format: int64 + example: 5 + uniqueVisitors: + description: Number of unique visitors + type: integer + format: int64 + example: 5 + type: object + WebsiteStats: + required: + - websiteId + properties: + websiteId: + description: The website ID + type: string + example: PvLI8C + name: + type: string + example: Variant A + pageViews: + description: The number of page views + type: integer + example: 1 + visits: + description: The number of visits + type: integer + example: 1 + uniqueVisitors: + description: The number of unique visitors + type: integer + example: 1 + thumbnailUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/wbe/N + type: object + WebsiteDetails: + type: object + allOf: + - $ref: '#/components/schemas/Website' + - properties: + pages: + type: array + items: + $ref: '#/components/schemas/WebsitePage' + type: object + WebsitePage: + properties: + uuid: + description: The website page ID + type: string + readOnly: true + example: 6ee7597f-9bde-4b92-9411-2fb228c9fa34 + name: + description: The website page name + type: string + example: Home + status: + description: The website page status + type: string + enum: + - active + - inactive + url: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: /terms-of-service + redirectUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: '' + createdAt: + description: The date the website page was created + type: string + format: date-time + type: object + TransactionalEmailsTemplatesUpdateTemplateRequest: + properties: + subject: + description: The template subject + type: string + example: Order Confirmation - Example Shop + content: + $ref: '#/components/schemas/TransactionalEmailTemplateContent' + type: object + ContactsCreateBatchContactsRequest: + required: + - campaignId + - contacts + properties: + campaignId: + description: ID of the destination campaign (list). + type: string + example: C + contacts: + description: Contacts that will be created. + type: array + items: + required: + - email + properties: + tags: + required: + - ids + properties: + ids: + description: List of tag IDs. + type: array + items: + type: string + example: kL6Nh + type: object + email: + type: string + format: email + example: john.doe@example.com + name: + type: string + maxLength: 128 + minLength: 1 + example: John Doe + dayOfCycle: + description: The day a contact is on in an autoresponder cycle. + type: string + example: '42' + scoring: + description: Contact's score + type: number + example: 8 + ipAddress: + description: Contact's IP address. IPv4 and IPv6 formats are accepted. + example: 1.2.3.4 + oneOf: + - type: string + format: ipv4 + - type: string + format: ipv6 + customFieldValues: + type: array + items: + required: + - customFieldId + - value + properties: + customFieldId: + description: Custom field ID. + type: string + example: kL6Nh + value: + type: array + items: + type: string + example: 18-35 + type: object + type: object + type: object + ContactsGetListOfActivitiesResponse: + type: array + items: + $ref: '#/components/schemas/ContactActivity' + ContactsGetSingleCampaignContactsResponse: + type: array + items: + $ref: '#/components/schemas/ContactListElement' + ContactsUpsertContactTagsResponse: + type: array + items: + $ref: '#/components/schemas/ContactTag' + SearchContactsByIdResponse: + type: array + items: + $ref: '#/components/schemas/SearchedContactDetails' + RssNewslettersGetStatisticsByIdResponse: + type: array + items: + $ref: '#/components/schemas/MessageStatisticsListElement' + TaxesGetListResponse: + type: array + items: + $ref: '#/components/schemas/Tax' + FormsGetListOfVariantsResponse: + type: array + items: + $ref: '#/components/schemas/FormVariantDetails' + LegacyLandingPagesGetByIdResponse: + type: array + items: + $ref: '#/components/schemas/BaseLandingPage' + CategoriesListResponse: + type: array + items: + $ref: '#/components/schemas/Category' + OrdersGetListResponse: + type: array + items: + $ref: '#/components/schemas/Order' + ProductsGetListResponse: + type: array + items: + $ref: '#/components/schemas/CreateAndUpdate' + ProductsUpsertCategoriesResponse: + type: array + items: + $ref: '#/components/schemas/BaseCategory' + ProductsUpsertMetaFieldsResponse: + type: array + items: + $ref: '#/components/schemas/MetaField' + CartsGetShopCartsResponse: + type: array + items: + $ref: '#/components/schemas/CreateAndUpdate' + NewslettersGetActivitiesResponse: + type: array + items: + $ref: '#/components/schemas/NewsletterActivity' + NewslettersGetThumbnailResponse: + type: string + format: binary + ProductVariantsGetProductVariantsListResponse: + type: array + items: + $ref: '#/components/schemas/ProductVariant' + AutorespondersGetThumbnailResponse: + type: string + format: binary + WebinarsGetListResponse: + type: array + items: + $ref: '#/components/schemas/Webinar' + SearchContactsSavedListResponse: + type: array + items: + $ref: '#/components/schemas/BaseSearchContacts' + TransactionalEmailsTemplatesGetListResponse: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailsTemplateListElement' + TransactionalEmailsGetListResponse: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailListElement' + TransactionalEmailsGetOverallStatisticsResponse: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailStatistics' + FromFieldsGetListResponse: + type: array + items: + $ref: '#/components/schemas/FromField' + RssNewslettersGetListResponse: + type: array + items: + $ref: '#/components/schemas/RssNewsletterListing' + RssNewslettersGetStatisticsResponse: + type: array + items: + $ref: '#/components/schemas/MessageStatisticsListElement' + CustomEventsGetListResponse: + type: array + items: + $ref: '#/components/schemas/CustomEvent' + FormsGetListResponse: + type: array + items: + $ref: '#/components/schemas/Form' + LegacyLandingPagesGetListResponse: + type: array + items: + $ref: '#/components/schemas/BaseLandingPage' + ImportsGetListResponse: + type: array + items: + $ref: '#/components/schemas/Import' + PredefinedFieldsGetListResponse: + type: array + items: + $ref: '#/components/schemas/PredefinedField' + SuppressionsGetSuppressionListsResponse: + type: array + items: + $ref: '#/components/schemas/Suppression' + SubscriptionConfirmationsGetCollectionOfBodiesResponse: + type: array + items: + $ref: '#/components/schemas/SubscriptionConfirmationBody' + SubscriptionConfirmationsGetSubjectCollectionResponse: + type: array + items: + $ref: '#/components/schemas/SubscriptionConfirmationSubject' + ShopsGetListOfShopsResponse: + type: array + items: + $ref: '#/components/schemas/CreateAndUpdate' + FormsAndPopupsGetListResponse: + type: array + items: + $ref: '#/components/schemas/PopupListItem' + AbTestsGetListResponse: + type: array + items: + $ref: '#/components/schemas/Splittest' + FileLibraryGetFileListResponse: + type: array + items: + $ref: '#/components/schemas/BaseFile' + FileLibraryListFoldersResponse: + type: array + items: + $ref: '#/components/schemas/Folder' + FileLibraryCreateFolderResponse: + type: array + items: + $ref: '#/components/schemas/Folder' + AbTestsSubjectGetListResponse: + type: array + items: + $ref: '#/components/schemas/AbtestsSubjectListItem' + ClickTracksGetListResponse: + type: array + items: + $ref: '#/components/schemas/ClickTrackResource' + NewslettersGetListResponse: + type: array + items: + $ref: '#/components/schemas/NewsletterListElement' + TagsGetListResponse: + type: array + items: + $ref: '#/components/schemas/BaseTag' + AddressesGetListResponse: + type: array + items: + $ref: '#/components/schemas/CreateAndUpdate' + CustomFieldsGetListResponse: + type: array + items: + $ref: '#/components/schemas/CustomField' + LandingPagesGetListResponse: + type: array + items: + $ref: '#/components/schemas/Lps' + MultimediaGetImageListResponse: + type: array + items: + $ref: '#/components/schemas/ImageDetails' + TrackingJavascriptCodeSnippetsResponse: + type: array + items: + $ref: '#/components/schemas/Tracking' + TrackingGetFacebookPixelsResponse: + type: array + items: + $ref: '#/components/schemas/FacebookPixel' + AccountsGetLoginHistoryResponse: + type: array + items: + $ref: '#/components/schemas/AccountsLoginHistoryListElement' + AccountsListIndustryTagsResponse: + type: array + items: + $ref: '#/components/schemas/IndustryTag' + AccountsGetTimezonesListResponse: + type: array + items: + $ref: '#/components/schemas/Timezone' + AccountsGetSendingLimitsResponse: + type: array + items: + $ref: '#/components/schemas/SendingLimitsListItem' + CampaignsListsGetListResponse: + type: array + items: + $ref: '#/components/schemas/BaseCampaign' + LegacyFormsGetListResponse: + type: array + items: + $ref: '#/components/schemas/LegacyForm' + GdprFieldsGetListResponse: + type: array + items: + $ref: '#/components/schemas/GDPRField' + WorkflowsListWorkflowsResponse: + type: array + items: + $ref: '#/components/schemas/Workflow' + WebsitesGetListResponse: + type: array + items: + $ref: '#/components/schemas/Website' + requestBodies: + NewShop: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndUpdate' + NewCategory: + content: + application/json: + schema: + $ref: '#/components/schemas/Category' + UpdateCategory: + content: + application/json: + schema: + $ref: '#/components/schemas/Category' + UpdateShop: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndUpdate' + NewMetaField: + content: + application/json: + schema: + $ref: '#/components/schemas/BaseMetaField' + NewProduct: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndUpdate' + UpdateProduct: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndUpdate' + UpsertProductCategory: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertProductCategory' + UpsertMetaField: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertMetaField' + UpdateMetaField: + content: + application/json: + schema: + $ref: '#/components/schemas/MetaField' + NewProductVariant: + content: + application/json: + schema: + $ref: '#/components/schemas/BaseProductVariant' + UpdateProductVariant: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductVariant' + NewTax: + content: + application/json: + schema: + $ref: '#/components/schemas/BaseTax' + UpdateTax: + content: + application/json: + schema: + $ref: '#/components/schemas/BaseTax' + NewAddress: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndUpdate' + UpdateAddress: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndUpdate' + NewOrder: + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + UpdateOrder: + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + NewCart: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndUpdate' + UpdateCart: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAndUpdate' + NewSearchContacts: + content: + application/json: + schema: + $ref: '#/components/schemas/NewSearchContacts' + UpdateSearchContacts: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSearchContacts' + SearchContactsConditionsDetails: + content: + application/json: + schema: + $ref: '#/components/schemas/SearchContactsConditionsDetails' + CreateTransactionalEmail: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTransactionalEmail' + CreateTransactionalEmailTemplate: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTransactionalEmailTemplate' + updateTransactionalEmailsTemplate: + content: + application/json: + schema: + $ref: >- + #/components/schemas/TransactionalEmailsTemplatesUpdateTemplateRequest + NewFromField: + content: + application/json: + schema: + $ref: '#/components/schemas/FromField' + NewCampaign: + content: + application/json: + schema: + $ref: '#/components/schemas/Campaign' + UpdateCampaign: + content: + application/json: + schema: + $ref: '#/components/schemas/Campaign' + UpdateAccount: + content: + application/json: + schema: + $ref: '#/components/schemas/Account' + NewAutoresponder: + content: + application/json: + schema: + $ref: '#/components/schemas/Autoresponder' + UpdateAutoresponder: + content: + application/json: + schema: + $ref: '#/components/schemas/Autoresponder' + NewRssNewsletter: + content: + application/json: + schema: + $ref: '#/components/schemas/RssNewsletter' + UpdateRssNewsletter: + content: + application/json: + schema: + $ref: '#/components/schemas/RssNewsletter' + NewContact: + content: + application/json: + schema: + $ref: '#/components/schemas/NewContact' + UpsertContactCustomFields: + content: + application/json: + schema: + $ref: '#/components/schemas/NewContactCustomFieldValues' + UpsertContactTags: + content: + application/json: + schema: + $ref: '#/components/schemas/NewContactTags' + UpdateContact: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateContact' + NewCustomField: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomField' + UpdateCustomField: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCustomField' + NewSuppression: + content: + application/json: + schema: + $ref: '#/components/schemas/BaseSuppression' + UpdateSuppression: + content: + application/json: + schema: + $ref: '#/components/schemas/BaseSuppression' + NewPredefinedField: + content: + application/json: + schema: + $ref: '#/components/schemas/PredefinedField' + UpdatePredefinedField: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePredefinedField' + UpdateCallbacks: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCallbacks' + TriggerCustomEvent: + content: + application/json: + schema: + $ref: '#/components/schemas/TriggerCustomEvent' + NewCustomEvent: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEvent' + UpdateCustomEvent: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEvent' + NewImport: + content: + application/json: + schema: + $ref: '#/components/schemas/NewImport' + NewFile: + content: + application/json: + schema: + $ref: '#/components/schemas/BaseFile' + NewFolder: + content: + application/json: + schema: + $ref: '#/components/schemas/NewFolder' + NewAbtestsSubject: + content: + application/json: + schema: + $ref: '#/components/schemas/NewAbtestsSubject' + ChooseWinnerAbtestsSubject: + content: + application/json: + schema: + $ref: '#/components/schemas/ChooseWinnerAbtestsSubject' + SendNewsletterDraft: + content: + application/json: + schema: + $ref: '#/components/schemas/SendNewsletterDraft' + NewNewsletter: + content: + application/json: + schema: + $ref: '#/components/schemas/NewNewsletter' + NewTag: + content: + application/json: + schema: + $ref: '#/components/schemas/BaseTag' + UpdateTag: + content: + application/json: + schema: + $ref: '#/components/schemas/BaseTag' + UpdateAccountBlocklist: + content: + application/json: + schema: + $ref: '#/components/schemas/Blocklist' + UpdateCampaignBlocklist: + content: + application/json: + schema: + $ref: '#/components/schemas/Blocklist' + CreateMultimedia: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/CreateMultimedia' + UpdateAccountBadge: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountBadgeDetails' + UpdateWorkflow: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateWorkflow' + headers: + CurrentPage: + description: The current page number + schema: + type: integer + format: int32 + TotalPages: + description: The total number of pages + schema: + type: integer + format: int32 + TotalCount: + description: The total number of resources found for the specified conditions + schema: + type: integer + format: int32 + RateLimitLimit: + description: The total number of requests available per time frame + schema: + type: integer + format: int32 + RateLimitRemaining: + description: The number of requests left in the current time frame + schema: + type: integer + format: int32 + RateLimitReset: + description: Seconds left in the current time frame, e.g. "432 seconds" + schema: + type: string + securitySchemes: + api-key: + description: Header value must be prefixed with api-key + type: apiKey + name: X-Auth-Token + in: header + oauth2: + type: oauth2 + flows: + implicit: + authorizationUrl: https://app.getresponse.com/oauth2_authorize.html + scopes: + all: all data access + authorizationCode: + authorizationUrl: https://app.getresponse.com/oauth2_authorize.html + tokenUrl: https://api.getresponse.com/v3/token + scopes: + all: all data access + clientCredentials: + tokenUrl: https://api.getresponse.com/v3/token + scopes: + all: all data access +externalDocs: + description: Find out more about API + url: https://apidocs.getresponse.com +x-tagGroups: + - tags: + - Accounts + - Multimedia + - File Library + name: User + - tags: + - Campaigns (Lists) + - Contacts + - Custom Fields + - Search Contacts + - Subscription Confirmations + - Predefined Fields + - Suppressions + - Imports + name: Contacts + - tags: + - Newsletters + - Autoresponders + - RSS Newsletters + - Legacy Landing Pages + - From Fields + - A/B tests + - A/B tests - subject + - Click Tracks + name: Email Marketing + - tags: + - Tags + name: Tags + - tags: + - GDPR Fields + name: GDPR Fields + - tags: + - Legacy Forms + - Forms + name: Forms and surveys + - tags: + - Workflows + - Custom Events + - Tracking + name: Automation + - tags: + - Addresses + - Carts + - Categories + - Meta Fields + - Orders + - Products + - Product Variants + - Shops + - Taxes + name: Ecommerce + - tags: + - Transactional Emails + - Transactional Emails Templates + name: Transactional Emails + - tags: + - SMS Messages + - SMS Automation Messages + name: SMS + - tags: + - Ecommerce + - Sms + - Website + - Landing Page + - Form and Popup + name: Statistics + - tags: + - Webinars + name: Webinars + - tags: + - Websites + - Landing Pages + name: Websites + - tags: + - Forms and Popups + name: Forms and Popups diff --git a/sdks/db/generate-repository-description-cache/customer-io-data-pipelines.json b/sdks/db/generate-repository-description-cache/customer-io-data-pipelines.json index 24d51fb013..f99b92cc2a 100644 --- a/sdks/db/generate-repository-description-cache/customer-io-data-pipelines.json +++ b/sdks/db/generate-repository-description-cache/customer-io-data-pipelines.json @@ -1,4 +1,4 @@ { "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products. \n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform. \n- Create and manage newsletters, transactional messages, and behavioral messages \n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time. \n\nLearn more: https://customer.io": "Customer.io is a versatile marketing automation tool that uses real-time data to send personalized messages for web and mobile products. Automate product messaging, manage newsletters, transactional messages, and behavioral messages, and connect with other apps for enhanced user engagement.", - "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products.\n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform.\n- Create and manage newsletters, transactional messages, and behavioral messages\n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time.\n\nLearn more: https://customer.io": "Customer.io is a versatile marketing automation tool that uses real-time data to deliver personalized messages across web and mobile products, including event reminders, onboarding emails, newsletters, and more. Automate messaging, create newsletters, and connect with other apps to drive user behavior." -} \ No newline at end of file + "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products.\n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform.\n- Create and manage newsletters, transactional messages, and behavioral messages\n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time.\n\nLearn more: https://customer.io": "Customer.io is a versatile marketing automation tool that uses real-time data to send relevant messages across web and mobile products, ensuring personalized and timely communication through automation and powerful segmentation. Customer.io's {language} SDK for Data Pipelines API generated by Konfig (https://konfigthis.com/)." +} diff --git a/sdks/db/generate-repository-description-cache/customer-io-journeys-app.json b/sdks/db/generate-repository-description-cache/customer-io-journeys-app.json index 71991e2ccc..0eee7a9a1c 100644 --- a/sdks/db/generate-repository-description-cache/customer-io-journeys-app.json +++ b/sdks/db/generate-repository-description-cache/customer-io-journeys-app.json @@ -1,4 +1,4 @@ { "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products. \n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform. \n- Create and manage newsletters, transactional messages, and behavioral messages \n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time. \n\nLearn more: https://customer.io": "Customer.io offers versatile marketing automation tools to personalize messages based on user behavior, ensuring timely and relevant communication across web and mobile platforms. Automate product messaging, newsletters, and more with real-time data integration for optimal user engagement and efficiency.", - "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products.\n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform.\n- Create and manage newsletters, transactional messages, and behavioral messages\n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time.\n\nLearn more: https://customer.io": "Customer.io is a dynamic tool for personalized marketing automation. Utilize real-time data to send targeted messages across web and mobile products, improving user experiences and engagement. Automate messaging and connect with other apps for effective user behavior management." -} \ No newline at end of file + "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products.\n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform.\n- Create and manage newsletters, transactional messages, and behavioral messages\n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time.\n\nLearn more: https://customer.io": "Customer.io is a versatile marketing automation tool that uses real-time data to deliver personalized messages across web and mobile products, enabling automated product messaging, newsletters, and behavioral messages. Connect with other apps for powerful segmentation and automation." +} diff --git a/sdks/db/generate-repository-description-cache/customer-io-journeys-track.json b/sdks/db/generate-repository-description-cache/customer-io-journeys-track.json index 17d07f7263..ee8534fa93 100644 --- a/sdks/db/generate-repository-description-cache/customer-io-journeys-track.json +++ b/sdks/db/generate-repository-description-cache/customer-io-journeys-track.json @@ -1,4 +1,4 @@ { "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products. \n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform. \n- Create and manage newsletters, transactional messages, and behavioral messages \n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time. \n\nLearn more: https://customer.io": "Customer.io is a versatile marketing automation tool that sends relevant messages based on user behavior across web and mobile. Real-time data ensures personalized messaging, from event reminders to onboarding emails. Automate product messaging, newsletters, and more with powerful segmentation and automation capabilities.", - "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products.\n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform.\n- Create and manage newsletters, transactional messages, and behavioral messages\n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time.\n\nLearn more: https://customer.io": "Customer.io offers a versatile marketing automation tool for personalized messaging based on user behavior. Automate product messaging, newsletters, and more to connect with users effectively and save time. Customer.io's {language} SDK for Journeys Track API generated by Konfig (https://konfigthis.com/)." -} \ No newline at end of file + "Customer.io is a versatile marketing automation tool for sending relevant messages based on behavior across web and mobile products.\n\nImpersonal messages lead to bad experiences. That's why we use real-time data to help you deliver the right message, exactly when it's needed — like sending an event reminder over SMS or the perfect onboarding email.\n\nOur robust platform enables you to:\n- Automate your product messaging, with the ability to build, test, and send messages from one platform.\n- Create and manage newsletters, transactional messages, and behavioral messages\n- Do more with your behavior and data -- connect our powerful segmentation and automation engine with other apps to drive user behavior and save time.\n\nLearn more: https://customer.io": "Customer.io is a versatile marketing automation tool using real-time data to deliver the right message at the right time. Automate product messaging, create newsletters, and connect with other apps to drive user behavior efficiently. Customer.io's {language} SDK for Journeys Track API generated by Konfig (https://konfigthis.com/)." +} diff --git a/sdks/db/generate-repository-description-cache/get-response.json b/sdks/db/generate-repository-description-cache/get-response.json new file mode 100644 index 0000000000..80c4957587 --- /dev/null +++ b/sdks/db/generate-repository-description-cache/get-response.json @@ -0,0 +1,3 @@ +{ + "GetResponse is a comprehensive email marketing platform that provides small businesses, solopreneurs, coaches, and marketers with powerful and affordable tools to grow their audience, engage with their subscribers, and turn subscribers into paying customers. With over 25 years of expertise, our customers choose GetResponse for our user-friendly solution, award-winning 24/7 customer support, and powerful tools that go beyond email marketing – with automation, list growth, and additional communication tools like webinars and live chats to help businesses build their personal brand, sell their products and services, and build a community.\n\nGetResponse's powerful email marketing software includes AI-enhanced content creation tools, professional templates, easy-to-use design tools, and proven deliverability. Our customers are empowered with tools to build a website and unlimited landing pages, and create engaging pop-ups and signup forms. The marketing automation builder brings your ideal automated communication scenario to life with a visual builder that can grow with your needs.\n\nWith our easy-to-use platform, proven expertise, and focus on user-friendly solutions, GetResponse is the ideal tool for small businesses, solopreneurs, coaches, and marketers looking to grow their audience, sell their products and services, and engage with their subscribers in a meaningful way.": "GetResponse is a user-friendly email marketing platform with powerful tools for audience growth, engagement, and conversion. Offering automation, list growth, webinars, and more to help businesses build their brand, sell products, and connect with subscribers efficiently. GetResponse's {language} SDK generated by Konfig (https://konfigthis.com/)." +} \ No newline at end of file diff --git a/sdks/db/intermediate-fixed-specs/getresponse/openapi.yaml b/sdks/db/intermediate-fixed-specs/getresponse/openapi.yaml new file mode 100644 index 0000000000..01d9885dd8 --- /dev/null +++ b/sdks/db/intermediate-fixed-specs/getresponse/openapi.yaml @@ -0,0 +1,35044 @@ +openapi: 3.0.0 +info: + title: GetResponse APIv3 + description: > + + + # Limits and throttling + + + GetResponse API calls are subject to throttling to ensure a high level of + service for all users. + + + ## Time frame + + + Time frame is a period of time for which we calculate the API call limits. + The limits reset in every time frame. + + + The time frame duration is **10 minutes**. + + + ## Basic rate limits + + + Each user is allowed to make **30,000 API calls per time frame** (10 + minutes) and **80 API calls per second**. + + + ## Parallel requests limit + + + It is possible to send up to **10 simultaneous requests**. + + + ## Headers + + + Every API response includes a few additional headers: + + + * `X-RateLimit-Limit` – the total number of requests available per time + frame + + * `X-RateLimit-Remaining` – the number of requests left in the current + time frame + + * `X-RateLimit-Reset` – seconds left in the current time frame + + + ## Errors + + + The **429 Too Many Requests** HTTP response code indicates that the limit + has been reached. The error response includes `currentLimit` and + `timeToReset` fields in the context section, with the total number of + requests available per time frame and seconds left in the current time frame + respectively. + + + ## Reaching the limit + + + When you reach the limit, you need to wait for the time specified in + `timeToReset` field or `X-RateLimit-Reset` header before making another + request. + + + # Authentication + + + API can be accessed by authenticated users only. This means that every + request must be signed with your credentials. We offer two methods of + authentication: API Key and OAuth 2.0. API key is our primary method and + should be used in most cases. GetResponse MAX clients have to send an + `X-Domain` header in addition to the API key. Supported OAuth 2.0 flows are: + Authorization Code, Client Credentials, Implicit, and Refresh Token. + + + ## API key + + + Follow these steps to send an authentication request: + + + * Find your unique and secret API key in the panel: + [https://app.getresponse.com/api](https://app.getresponse.com/api) + + * Add a custom `X-Auth-Token` header to all your requests. For example, if + your API key is `jfgs8jh4ksg93ban9Dfgh8`, the header will look like this: + + + ``` + + X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8 + + ``` + + + **For security reasons, unused API keys expire after 90 days. When that + happens, you’ll need to generate a new key to use our API.** + + + ### Example authenticated request + + + ``` + + $ curl -H "X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8" + https://api.getresponse.com/v3/accounts + + ``` + + + ## OAuth 2.0 + + + To use OAuth 2.0 authentication, you need to get an "Access Token". For more + information on how to obtain a token, head to our dedicated page: [OAuth + 2.0](/#section/Authentication/Using-OAuth-2.0) + + + To authenticate a request using an Access Token, set the value of + `Authorization` header to "Bearer" followed by the Access Token. + + + ### Example + + + If the Access Token is `jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8` + + + ``` + + Authorization: Bearer jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8 + + ``` + + + ## GetResponse MAX + + + GetResponse MAX customers need to take an extra step to authenticate the + request. All requests have to be send with an `X-Domain` header that + contains the client's domain. For example: + + + ``` + + X-Domain: example.com + + ``` + + + Please note that the header must contain only the domain name, without the + protocol identifier (`http://` or `https://`). + + + ## Using OAuth 2.0 + + + ### Registering your own application + + + If you want to use an OAuth flow to authorize your application, first + [register your application](https://app.getresponse.com/authorizations) + + + You need to provide a name, short description, and redirect URL. + + + ### Choosing grant flow + + + Once your application is registered, you can click on it to see your + `client_id` and `client_secret`. They're basically a login and password for + your application's access, so be sure not to share them with anyone. + + + Next, decide which authentication flow (grant type) you want to use. Here + are your options: + + + - choose the **Authorization Code** flow if your application is server-based + (you have a server with its own domain and server-side code), + + - choose the **Implicit** flow if your application is based mostly on + JavaScript or client-side code, + + - choose the **Client Credential** flow if you want to test your application + or access your GetResponse account, + + - implement the **Refresh Token** flow to handle token expiration if you use + the Authorization Code flow. + + + ### Authorization Code flow + + + First, your application must redirect a resource owner to the following URL: + + + ``` + + https://app.getresponse.com/oauth2_authorize.html?response_type=code&client_id=_your_client_id_&state=xyz + + ``` + + + The `state` parameter is there for security reasons and should be a random + string. When the resource owner grants your application access to the + resource, we will redirect the browser to the `redirect URL` you specified + in the application settings and attach the same state as the parameter. + Comparing the state parameter value ensures that the redirect was initiated + by our system. The code parameter is an authorization code that you can + exchange for an access token within 10 minutes, after which time it expires. + + + #### Example redirect with authorization code + + + ``` + + https://myredirecturi.com/cb?code=ed17c498bfe343175cd7684c5b09979f2875b25c&state=xyz + + ``` + + + #### Exchanging authorization code for the access token + + + Here's an example request to exchange authorization code for the access + token: + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=authorization_code&code=ed17c498bfe343175cd7684c5b09979f2875b25c' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + ##### Example response + + + ```json + + { + "access_token": "03807cb390319329bdf6c777d4dfae9c0d3b3c35", + "expires_in": 3600, + "token_type": "Bearer", + "scope": null, + "refresh_token": "170d9f64e781aaa6b3ba036083faba71b2fc4e6c" + } + + ``` + + + ### Client Credentials flow + + + This flow is suitable for development, when you need to quickly access API + to create some functionality. You can get the access token with a single + request: + + + #### Request + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=client_credentials' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + #### Response + + + ```json + + { + "access_token": "e2222af2851a912470ec33c9b4de1ea3a304b7d7", + "expires_in": 86400, + "token_type": "Bearer", + "scope": null + } + + ``` + + + You can also go to https://app.getresponse.com/manage_api.html, click the + action button for your application, and select "generate credentials". This + will open a popup with a generated access token. You can then use the access + token to authenticate your requests, for example: + + + ``` + + $ curl -H "Authorization: Bearer e2222af2851a912470ec33c9b4de1ea3a304b7d7" + https://api.getresponse.com/v3/from-fields + + ``` + + + ### Implicit flow + + + First, your application must redirect a resource owner to the following URL: + + + ``` + + https://app.getresponse.com/oauth2_authorize.html?response_type=token&client_id=_your_client_id_&redirect_uri=https://myredirecturi.com/cb&state=xyz + + ``` + + + When the resource owner grants your application access to the resource, we + will redirect the owner to the URL that was specified in the request. + + + There is no code exchange process because, unlike the Authorization Code + flow, the redirect already has the access token in the parameters. + + + ``` + + https://myredirecturi.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA&state=xyz&token_type=bearer&expires_in=3600 + + ``` + + + ### Refresh Token flow + + + You need to refresh your access token if you receive this error message as a + response to your request: + + + ```json + + { + "httpStatus": 401, + "code": 1014, + "codeDescription": "Problem during authentication process, check headers!", + "message": "The access token provided is expired", + "moreInfo": "https://apidocs.getresponse.com/v3/errors/1014", + "context": { + "sentToken": "b8b1e961a7f9fd4cc710d5d955e09c15a364ab71" + } + } + + ``` + + + If you are using the Authorization Code flow, you need to use the refresh + token to issue a new access token/refresh token pair by making the following + request: + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=refresh_token&refresh_token=170d9f64e781aaa6b3ba036083faba71b2fc4e6c' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + The response you'll get will look like this: + + + ```json + + { + "access_token": "890fdsa2f5d7b189fc4e6c4b1d170d9f591238ss", + "expires_in": 86400, + "token_type": "Bearer", + "scope": null, + "refresh_token": "170d9f64e781aaa6b3ba036083faba71b2fc4e6c" + } + + ``` + + + ### GetResponse MAX + + + There are some differences when authenticating GetResponse MAX users: + + + - the application must redirect to a page in the client's custom domain, for + example: `https://custom-domain.getresponse360.com/oauth2_authorize.html` + + - token requests have to be send to one of the GetResponse MAX APIv3 + endpoints (depending on the client's environment), + + - token requests have to include an `X-Domain` header, + + - the application has to be registered in a GetResponse MAX account within + the same environment. + + + + # CORS (AJAX requests) + + + [Cross-Origin Resource Sharing + (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) mechanism is + not supported by APIv3. It means that AJAX requests to the API will be + blocked by the browser's [same-origin + policy](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy). + Please use a server-side application to access the API. + + + + # Timezone settings + + + The default timezone in response data is **UTC**. + + + To set a different timezone, add `X-Time-Zone` header with value of [time + zone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) + ("TZ database name" column). + + + + # Pagination + + + Most of the resource collections returned by API are paginated. It means + that the response is divided into multiple pages. + + + Control the number of results on each page by using `perPage` query + parameter and change pages by using `page` query parameter. + + + By default we return only the first **100** resources per page. You can + change that by adding `perPage` parameter with a value of up to **1000**. + + + Page numbers start with **1**. + + + Paginated responses have 3 extra headers: + + * `TotalCount` – a total number of resources on all pages + + * `TotalPages` – a total number of pages + + * `CurrentPage` – current page number + + + Use the maximum `perPage` value (**1000**) if you plan to iterate over all + the pages of the response. + + + When trying to get a page that exceeds the total number of pages, API will + return an empty array (`[]`). Make sure to stop iterating when it happens. + + + + # CURLE_SSL_CACERT error + + + Solution to CURLE_SSL_CACERT error (code 60). + + + This error is related to expired CA (Certificate Authority) certificates + installed on your server (the server that you send the requests from). You + can read more about certificate verification on the [cURL project + website](https://curl.haxx.se/docs/sslcerts.html). + + + If you encounter this error while sending requests to the GetResponse APIv3, + ask your server administrator to update the CA certificates using the + [latest bundle provided by the cURL + project](https://curl.haxx.se/docs/caextract.html). + + + **Please make sure that cURL is configured to use the updated bundle.** + contact: + name: API Support - DevZone + url: https://app.getresponse.com/feedback.html?devzone=yes + email: getresponse-devzone@cs.getresponse.com + version: 3.2024-03-04T09:53:07+0000 + x-logo: + url: https://us-ws.gr-cdn.com/images/global/getresponse.png +servers: + - url: https://api.getresponse.com/v3 + description: GetResponse + - url: https://api3.getresponse360.com/v3 + description: GetResponse MAX US + - url: https://api3.getresponse360.pl/v3 + description: GetResponse MAX PL +paths: + /webinars/{webinarId}: + get: + tags: + - Webinars + summary: Get a webinar by ID + operationId: getWebinarById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/WebinarDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/webinarId' + /contacts/{contactId}: + get: + tags: + - Contacts + summary: Get contact details by contact ID + operationId: getContactById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ContactDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Contacts + summary: Update contact details + description: >- + Skip the fields you don't want to update. If tags and custom fields are + provided, they'll be **replaced** with the values sent in this request. + If the `campaignId` changes, the contact will be moved from the original + campaign (list) to the new campaign (list). Their activity history and + statistics will also be moved. + operationId: updateContact + requestBody: + $ref: '#/components/requestBodies/UpdateContact' + responses: + '200': + $ref: '#/components/responses/ContactDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Contacts + summary: Delete a contact by contact ID + operationId: deleteContact + parameters: + - name: messageId + in: query + description: >- + > + + The ID of a message (such as a newsletter, an autoresponder, or an + RSS-newsletter). + + When passed, this method will simulate the unsubscribe process, as + if the contact clicked the unsubscribe link in a given message. + required: false + schema: + type: string + - name: ipAddress + in: query + description: >- + This makes it possible to pass the IP from which the contact + unsubscribed. Used only if the `messageId` was send. + schema: + type: string + format: ipv4 + responses: + '204': + description: Empty response. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/contactId' + /contacts/{contactId}/activities: + get: + tags: + - Contacts + summary: Get a list of contact activities + description: >- + By default, only activities from the last 14 days are returned. To get + earlier data, use `query[createdOn]` parameter. You can filter the + resource using criteria specified as `query[*]`. You can provide + multiple criteria, to use AND logic. You can sort the resource using + parameters specified as `sort[*]`. You can specify multiple fields to + sort by. + operationId: getActivities + parameters: + - name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ContactActivityList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/contactId' + /campaigns/{campaignId}/contacts: + get: + tags: + - Contacts + summary: Get contacts from a single campaign + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getContactsFromCampaign + parameters: + - name: query[email] + in: query + description: Search contacts by email + required: false + schema: + type: string + - name: query[name] + in: query + description: Search contacts by name + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[email] + in: query + description: Sort contacts by email + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + description: Sort contacts by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort contacts by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ContactList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/campaignId' + /contacts/{contactId}/custom-fields: + post: + tags: + - Contacts + summary: Upsert the custom fields of a contact + description: >- + Upsert (add or update) the custom fields of a contact. This method + doesn't remove (unassign) custom fields. + operationId: upsertContactCustoms + requestBody: + $ref: '#/components/requestBodies/UpsertContactCustomFields' + responses: + '200': + $ref: '#/components/responses/ContactCustomFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: upsert + parameters: + - $ref: '#/components/parameters/contactId' + /contacts/{contactId}/tags: + post: + tags: + - Contacts + summary: Upsert the tags of a contact + description: >- + Upsert (add or update) the tags of a contact. This method doesn't remove + (unassign) tags. + operationId: upsertTags + requestBody: + $ref: '#/components/requestBodies/UpsertContactTags' + responses: + '200': + $ref: '#/components/responses/UpsertContactTags' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: upsert + parameters: + - $ref: '#/components/parameters/contactId' + /search-contacts/{searchContactId}: + get: + tags: + - Search Contacts + summary: Get search contacts by contact ID. + description: Get the definition of a specific contact-search filter. + operationId: getSearchContactsById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SearchContactsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Search Contacts + summary: Update search contacts + description: Update specified search contacts. + operationId: updateSearchContacts + requestBody: + $ref: '#/components/requestBodies/UpdateSearchContacts' + responses: + '200': + $ref: '#/components/responses/SearchContactsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Search Contacts + summary: Delete search contacts + operationId: deleteSearchContacts + responses: + '204': + description: Delete search contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/searchContactId' + /search-contacts/{searchContactId}/contacts: + get: + tags: + - Search Contacts + summary: Get contacts by search contacts ID + description: Get contacts from saved search contacts by ID. + operationId: getContactsByIdSearchContacts + parameters: + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - name: sort[email] + in: query + description: Sort by email + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - name: sort[createdOn] + in: query + description: Sort by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: asc + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SearchedContactsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/searchContactId' + /search-contacts/{searchContactId}/custom-fields: + post: + tags: + - Search Contacts + summary: Upsert custom fields by search contacts + description: >- + Makes it possible to add and update custom field values for all contacts + that meet the search criteria. This method doesn't remove or overwrite + custom fields with the values from the request. + operationId: upsertCustomFieldsBySearchContactId + requestBody: + $ref: '#/components/requestBodies/UpsertContactCustomFields' + responses: + '202': + description: Upsert custom fields by searchContactId. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: UpsertCustomFieldsBySearchContactsId + parameters: + - $ref: '#/components/parameters/searchContactId' + /transactional-emails/templates/{transactionalTemplateId}: + get: + tags: + - Transactional Emails Templates + summary: Get a single template by ID + operationId: getTransactionalEmailsTemplatesById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailsTemplateDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + post: + tags: + - Transactional Emails Templates + summary: Update transactional email template + description: This method allows you to update transactional email template + operationId: updateTransactionalEmailsTemplate + requestBody: + $ref: '#/components/requestBodies/updateTransactionalEmailsTemplate' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailsTemplateDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + delete: + tags: + - Transactional Emails Templates + summary: Delete transactional email template + operationId: deleteTransactionalEmailsTemplate + responses: + '204': + description: Delete transactional email template + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + parameters: + - $ref: '#/components/parameters/transactionalTemplateId' + /transactional-emails/{transactionalEmailId}: + get: + tags: + - Transactional Emails + summary: Get transactional email details by transactional email ID + operationId: getTransactionalEmailsById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + parameters: + - $ref: '#/components/parameters/transactionalEmailId' + /from-fields/{fromFieldId}: + get: + tags: + - From Fields + summary: Get a single 'From' address by ID + operationId: getFromFieldById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/FromFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - From Fields + summary: Delete 'From' address + operationId: deleteFromField + parameters: + - name: fromFieldIdToReplaceWith + in: query + description: The 'From' address ID that should replace the deleted 'From' address + required: false + schema: + type: string + responses: + '204': + description: Delete 'From' address. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/fromFieldId' + /from-fields/{fromFieldId}/default: + post: + tags: + - From Fields + summary: Set a 'From' address as default + operationId: setFromFieldAsDefault + responses: + '200': + description: Set a 'From' address as default. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: SetDefaultFromField + x-no-body: true + x-type: update + parameters: + - $ref: '#/components/parameters/fromFieldId' + /rss-newsletters/{rssNewsletterId}: + get: + tags: + - RSS Newsletters + summary: Get RSS newsletter by ID + operationId: getRssNewsletterById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/RssNewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - RSS Newsletters + summary: Update RSS newsletter + operationId: updateRssNewsletter + requestBody: + $ref: '#/components/requestBodies/UpdateRssNewsletter' + responses: + '200': + $ref: '#/components/responses/RssNewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - RSS Newsletters + summary: Delete RSS newsletter + operationId: deleteRssNewsletter + responses: + '204': + description: Delete RSS newsletter. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/rssNewsletterId' + /rss-newsletters/{rssNewsletterId}/statistics: + get: + tags: + - RSS Newsletters + summary: Get RSS newsletter statistics by ID + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getSingleRssNewsletterStatisticsCollection + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SingleMessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetRssNewsletterStatistics + parameters: + - $ref: '#/components/parameters/rssNewsletterId' + /shops/{shopId}/taxes: + get: + tags: + - Taxes + summary: Get a list of taxes + description: >- + + Sending **GET** request to this URL returns a collection of tax + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below, in the request params + section). You can basically search by: + * name + * createdOn + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getTaxList + parameters: + - name: query[name] + in: query + description: Search tax by name + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search tax created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search tax created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TaxList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Taxes + summary: Create tax + description: > + + Sending a **POST** request to this URL will create a new tax resource. + + + In order to create a new tax, you need to send a tax resource in the + body of the request (remember that you need to serialize the body into a + JSON string) + operationId: createTax + requestBody: + $ref: '#/components/requestBodies/NewTax' + responses: + '201': + $ref: '#/components/responses/TaxDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: CreateTax + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/taxes/{taxId}: + get: + tags: + - Taxes + summary: Get a single tax by ID + description: > + + This method returns tax with a given `taxId` in the context of a given + `shopId` + operationId: getTaxById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TaxDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetTax + post: + tags: + - Taxes + summary: Update tax + description: > + + Update the properties of the shop tax. You should only send the fields + that need to be changed. The rest of the properties will stay the same. + operationId: updateTax + requestBody: + $ref: '#/components/requestBodies/UpdateTax' + responses: + '200': + $ref: '#/components/responses/TaxDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: UpdateTax + delete: + tags: + - Taxes + summary: Delete tax by ID + description: '' + operationId: deleteTax + responses: + '204': + description: Delete tax + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: DeleteTax + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/taxId' + /custom-events/{customEventId}: + get: + tags: + - Custom Events + summary: Get custom events by custom event ID + operationId: getCustomEventById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CustomEventDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Custom Events + summary: Update custom event details + operationId: updateCustomEvent + requestBody: + $ref: '#/components/requestBodies/UpdateCustomEvent' + responses: + '200': + $ref: '#/components/responses/CustomEventDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Custom Events + summary: Delete a custom event by custom event ID + operationId: deleteCustomEvent + responses: + '204': + description: Delete custom event + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/customEventId' + /forms/{formId}: + get: + tags: + - Forms + summary: Get form by ID + operationId: getForm + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/FormDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/formId' + /forms/{formId}/variants: + get: + tags: + - Forms + summary: Get the list of form variants (A/B tests) + operationId: getFormVariantList + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/FormVariantList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/formId' + /landing-pages/{landingPageId}: + get: + tags: + - Legacy Landing Pages + summary: Get single landing page by ID + operationId: getLandingPageById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LandingPageDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/landingPageId' + /imports/{importId}: + get: + tags: + - Imports + summary: Get import details by ID. + operationId: getImportById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ImportDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/importId' + /statistics/sms/{smsId}: + get: + tags: + - Sms + summary: Get details for the SMS message statistics + operationId: getSmsStats + parameters: + - name: query[createdOn][from] + in: query + description: Get statistics for a single SMS from this date + schema: + type: string + format: date + example: '2023-01-20' + - name: query[createdOn][to] + in: query + description: Get statistics for a single SMS to this date + schema: + type: string + format: date + example: '2023-01-20' + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SmsStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + parameters: + - $ref: '#/components/parameters/smsId' + /predefined-fields/{predefinedFieldId}: + get: + tags: + - Predefined Fields + summary: Get a predefined field by ID + description: Get detailed information about a specified predefined field. + operationId: getPredefinedFieldById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/PredefinedFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Predefined Fields + summary: Update a predefined field + operationId: updatePredefinedField + requestBody: + $ref: '#/components/requestBodies/UpdatePredefinedField' + responses: + '200': + $ref: '#/components/responses/PredefinedFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Predefined Fields + summary: Delete a predefined field + operationId: deletePredefinedField + responses: + '204': + description: Delete a predefined field. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/predefinedFieldId' + /shops/{shopId}/categories: + get: + tags: + - Categories + summary: Get the shop categories list + description: >- + + Sending a **GET** request to this URL returns a collection of category + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + *name + * createdOn + * parentId + + The `name` fields can be a pattern and we'll try to match this phrase. + + + The `parentId` will search for sub-categories of a given parent + category. + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getCategories + parameters: + - name: query[name] + in: query + description: Search category by name + required: false + schema: + type: string + - name: query[parentId] + in: query + description: Search categories by their parent + required: false + schema: + type: string + - name: query[externalId] + in: query + description: Search categories by external ID + required: false + schema: + type: string + - name: search[createdAt][from] + in: query + description: Show categories starting from this date + required: false + schema: + type: string + format: date-time + - name: search[createdAt][to] + in: query + description: Show categories starting to this date + required: false + schema: + type: string + format: date-time + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdAt] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CategoryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Categories + summary: Create category + description: >+ + + Create shop category. You can pass the `parentId` parameter to create a + sub-category of a given parent. Unlike most **POST** methods, this call + is idempotent, that is: sending the same request 10 times will not + create 10 new categories. Only one category will be created. + + operationId: createCategory + requestBody: + $ref: '#/components/requestBodies/NewCategory' + responses: + '201': + $ref: '#/components/responses/CategoryDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/categories/{categoryId}: + get: + tags: + - Categories + summary: Get a single category by ID + description: | + + This method returns a category according to the given `categoryId`. + operationId: getCategory + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CategoryDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Categories + summary: Update category + description: >+ + + Update the properties of the shop category. You can specify a `parentId` + to assign a category as sub-category for an existing category. You + should send only those fields that need to be changed. The rest of the + properties will stay the same. + + operationId: updateCategory + requestBody: + $ref: '#/components/requestBodies/UpdateCategory' + responses: + '200': + $ref: '#/components/responses/CategoryDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Categories + summary: Delete category + description: '' + operationId: deleteCategory + responses: + '204': + description: Delete category + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/categoryId' + /suppressions/{suppressionId}: + get: + tags: + - Suppressions + summary: Get a suppression list by ID + operationId: getSuppressionById + responses: + '200': + $ref: '#/components/responses/SuppressionDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Suppressions + summary: Update a suppression list by ID + operationId: updateSuppression + requestBody: + description: The suppression list to be updated. + $ref: '#/components/requestBodies/UpdateSuppression' + responses: + '200': + $ref: '#/components/responses/SuppressionDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Suppressions + summary: Deletes a given suppression list by ID + operationId: deleteSuppression + responses: + '204': + description: Suppression list deleted successfully. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/suppressionId' + /shops/{shopId}/orders: + get: + tags: + - Orders + summary: Get the list of orders + description: >- + + Sending a **GET** request to this URL returns a collection of order + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + * description + * status + * externalId + * processedAt + + The `description` fields can be a pattern and we'll try to match this + phrase. + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getOrderList + parameters: + - name: query[description] + in: query + description: Search order by description + required: false + schema: + type: string + - name: query[status] + in: query + description: Search order by status + required: false + schema: + type: string + - name: query[externalId] + in: query + description: Search order by external ID + required: false + schema: + type: string + - name: query[processedAt][from] + in: query + description: Show orders processed from this date + required: false + schema: + type: string + format: date-time + - name: query[processedAt][to] + in: query + description: Show orders processed to this date + required: false + schema: + type: string + format: date-time + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/OrderList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Orders + summary: Create order + description: >+ + + Sending a **POST** request to this URL will create a new order resource. + + + In order to create a new order, you need to send the order resource in + the body of the request (remember that you need to serialize the body + into a JSON string). + + operationId: createOrder + parameters: + - name: additionalFlags + in: query + description: >- + The additional flags parameter with the value `skipAutomation` will + skip the triggering `Make a purchase` element in an automated + workflow + required: false + schema: + type: string + example: skipAutomation + x-set: + - skipAutomation + requestBody: + $ref: '#/components/requestBodies/NewOrder' + responses: + '201': + $ref: '#/components/responses/OrderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/orders/{orderId}: + get: + tags: + - Orders + summary: Get a single order by ID + description: |+ + + This method returns the order according to the given `orderId`. + + operationId: getOrderById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/OrderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Orders + summary: Update order + description: >+ + + Update the properties of a shop's order. You should send only those + fields that need to be changed. The rest of the properties will stay the + same. + + However, in case of `billingAddress` and `shippingAddress`, you must + send the entire representation. Individual fields can't be updated. + + If you want to update individual fields of an address, you can do so + using `POST /v3/addresses/{addressId}`. + + + In case of `selectedVariants`, when the collection is updated, the old + collection is completely removed. The same goes for meta fields. + + Individual fields can't be updated either. The full representations of + `selectedVariants` and `metaFields` must be sent instead. + + operationId: updateOrder + parameters: + - name: additionalFlags + in: query + description: >- + The additional flags parameter with the value `skipAutomation` will + skip the triggering `Make a purchase` element in an automated + workflow + required: false + schema: + type: string + example: skipAutomation + x-set: + - skipAutomation + requestBody: + $ref: '#/components/requestBodies/UpdateOrder' + responses: + '200': + $ref: '#/components/responses/OrderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Orders + summary: Delete order + description: '' + operationId: deleteOrder + responses: + '204': + description: Delete order + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/orderId' + /shops/{shopId}/products: + get: + tags: + - Products + summary: Get a product list. + description: >- + + Sending a **GET** request to this URL returns a collection of product + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + * name + * vendor + * category + * categoryId + * externalId + * variantName + * metaFieldNames + * metaFieldValues + * createdOn + + The `metaFieldNames` and `metaFieldValues` fields can be a list of + values separated by a comma [,]. + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getProductList + parameters: + - name: query[name] + in: query + description: Search products by name + required: false + schema: + type: string + - name: query[vendor] + in: query + description: Search products by vendor + required: false + schema: + type: string + - name: query[category] + in: query + description: Search products by category name + required: false + schema: + type: string + - name: query[categoryId] + in: query + description: Search products by category ID + required: false + schema: + type: string + - name: query[externalId] + in: query + description: Search products by external ID + required: false + schema: + type: string + - name: query[variantName] + in: query + description: Search products by product variant name + required: false + schema: + type: string + - name: query[metaFieldNames] + in: query + description: >- + Search products by meta field name (the list of names must be + separated by a comma [,]) + required: false + schema: + type: string + - name: query[metaFieldValues] + in: query + description: >- + Search products by meta field value (the list of values must be + separated by a comma [,]) + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search products created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search products created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ProductList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Products + summary: Create product + description: >+ + + Sending a **POST** request to this URL will create a new product + resource. + + + In order to create a new product, you need to send the product resource + in the body of the request (remember that you need to serialize the body + into a JSON string) + + + You don't need a separate endpoint for each element (e.g. variant, + category, meta-field). You can create them all with this method. + + + Please note that categories aren't required, but if a product has at + least one category, then one of those categories must be marked as + default. + + This can be set by field `isDefault`. If none of the elements contains + isDefault=true, then the system picks the first one from the collection + by default. + + operationId: createProduct + requestBody: + $ref: '#/components/requestBodies/NewProduct' + responses: + '201': + $ref: '#/components/responses/ProductDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/products/{productId}: + get: + tags: + - Products + summary: Get a single product by ID + description: >+ + + This method returns product according to the given `productId` in the + context of a given `shopId`. + + operationId: getProductById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ProductDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Products + summary: Update product + description: >+ + + Update the properties of a shop's product. You should only send those + fields that need to be changed. The remaining properties will stay the + same. + + However, when updating variants, categories, and meta fields, you need + to send entire collections. Individual fields can't be updated. + + If you want to update particular fields, you can do so using their + specific endpoints, i.e.: + + * categories - `POST /v3/shops/{shopId}/categories/{categoryId}` + * variants - POST `/v3/shops/{shopId}/products/{productId}/variants/{variantId}` + * metaFields - `POST /v3/shops/{shopId}/meta-fields/{metaFieldId}` + + + operationId: updateProduct + requestBody: + $ref: '#/components/requestBodies/UpdateProduct' + responses: + '200': + $ref: '#/components/responses/ProductDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Products + summary: Delete product + description: '' + operationId: deleteProduct + responses: + '204': + description: Delete product + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + /shops/{shopId}/products/{productId}/categories: + post: + tags: + - Products + summary: Upsert product categories + description: >+ + + This method makes it possible to assign product categories, and to set a + default product category. This method doesn't remove or unassign product + categories. It returns a list of product categories. + + + Please note that if you assign only one category to a given product, + that category is marked as default. If you try to remove the default + mark, your change won't be executed. + + operationId: upsertProductCategories + requestBody: + $ref: '#/components/requestBodies/UpsertProductCategory' + responses: + '200': + $ref: '#/components/responses/SimpleProductCategoryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: upsert + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + /shops/{shopId}/products/{productId}/meta-fields: + post: + tags: + - Products + summary: Upsert product meta fields + description: >+ + + This method makes it possible to assign meta fields. It doesn't remove + or unassign meta fields. It returns a list of product meta fields. + + operationId: upsertMetaFields + requestBody: + $ref: '#/components/requestBodies/UpsertMetaField' + responses: + '200': + $ref: '#/components/responses/MetaFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: upsert + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + /shops/{shopId}: + get: + tags: + - Shops + summary: Get a single shop by ID + description: |+ + + This method returns the shop according to the given `shopId` + + operationId: getShopById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ShopDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Shops + summary: Update shop + description: >+ + + This makes it possible to update shop preferences. You should send only + those fields that need to be changed. The rest of the properties remain + the same. + + operationId: updateShop + requestBody: + $ref: '#/components/requestBodies/UpdateShop' + responses: + '200': + $ref: '#/components/responses/ShopDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Shops + summary: Delete shop + description: |+ + + This method deletes a shop. + + operationId: deleteShop + responses: + '204': + description: Delete a shop + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /popups/{popupId}: + get: + tags: + - Forms and Popups + summary: Get a single form or popup by ID + operationId: getPopupDetails + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/PopupDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/popupId' + /statistics/popups/{popupId}/performance: + get: + tags: + - Form and Popup + summary: Get statistics for a single form or popup + operationId: getPopupGeneralPerformance + parameters: + - name: query[date][from] + in: query + description: Get statistics for a single form or popup from this date + required: false + schema: + type: string + format: date + example: '2023-01-10' + - name: query[date][to] + in: query + description: Get statistics for a single form or popup to this date + required: false + schema: + type: string + format: date + example: '2023-01-20' + - name: query[location] + in: query + description: Form or popup statistics by location + required: false + schema: + type: string + - name: query[device] + in: query + description: Form or popup statistics by device + required: false + schema: + type: string + enum: + - desktop + - mobile + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/PopupGeneralPerformance' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/popupId' + /splittests/{splittestId}: + get: + tags: + - A/B tests + summary: Get a single A/B test. + description: Get a single A/B test by ID. + operationId: getSplittest + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/Splittest' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/splittestId' + /shops/{shopId}/carts: + get: + tags: + - Carts + summary: Get shop carts + description: >- + + Sending a **GET** request to this URL returns a collection of cart + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * externalId + * createdOn + + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getCarts + parameters: + - name: query[createdOn][from] + in: query + description: Search carts created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search carts created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[externalId] + in: query + description: Search cart by external ID + required: false + schema: + type: string + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CartList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Carts + summary: Create cart + description: >+ + + Sending a **POST** request to this URL will create a new cart resource. + + + In order to create a new cart, you need to send the cart resource in the + body of the request (remember that you need to serialize the body into a + JSON string) + + operationId: createCart + requestBody: + $ref: '#/components/requestBodies/NewCart' + responses: + '201': + $ref: '#/components/responses/CartDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/carts/{cartId}: + get: + tags: + - Carts + summary: Get cart by ID + description: >+ + + This method returns cart with the given `cartId` in the context of a + given `shopId` + + operationId: getCart + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CartDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Carts + summary: Update cart + description: >+ + + Update properties of the shop cart. You should send only those fields + that need to be changed. The rest of the properties will stay the same. + + + In case of selectedVariants, when the collection is updated, the old one + is completely removed. + + operationId: updateCart + requestBody: + $ref: '#/components/requestBodies/UpdateCart' + responses: + '200': + $ref: '#/components/responses/CartDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Carts + summary: Delete cart + description: '' + operationId: deleteCart + responses: + '204': + description: Delete cart + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/cartId' + /file-library/files/{fileId}: + get: + tags: + - File Library + summary: Get file by ID + operationId: getFileById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/File' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - File Library + summary: Delete file by file ID + operationId: deleteFile + responses: + '204': + description: Delete file + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/fileId' + /file-library/folders/{folderId}: + delete: + tags: + - File Library + summary: Delete folder by folder ID + operationId: deleteFolder + responses: + '204': + description: Delete folder + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/folderId' + /ab-tests/subject/{abTestId}: + get: + tags: + - A/B tests - subject + summary: Get a single A/B test by ID + operationId: getAbtestsSubjectById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AbtestsSubjectGetDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/abTestId' + /ab-tests/subject/{abTestId}/winner: + post: + tags: + - A/B tests - subject + summary: Choose A/B test winner + operationId: postAbtestsSubjectByIdWinner + requestBody: + $ref: '#/components/requestBodies/ChooseWinnerAbtestsSubject' + responses: + '204': + description: Choose A/B test winner + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/abTestId' + /click-tracks/{clickTrackId}: + get: + tags: + - Click Tracks + summary: Get click tracked link details by click track ID + operationId: getClickTrackById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ClickTrack' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/clickTrackId' + /newsletters/{newsletterId}: + get: + tags: + - Newsletters + summary: Get a single newsletter by its ID. + operationId: getNewsletter + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Newsletters + summary: Delete newsletter + operationId: deleteNewsletter + responses: + '204': + description: Delete newsletter. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/newsletterId' + /newsletters/{newsletterId}/activities: + get: + tags: + - Newsletters + summary: Get newsletter activities + description: >- + By default, activities from the **last 14 days** are listed only. You + can get activities for last 30 days only. You can filter the resource + using criteria specified as `query[*]`. You can provide multiple + criteria, to use AND logic. You can sort the resource using parameters + specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getNewsletterActivities + parameters: + - name: query[activity] + in: query + description: Search newsletter activities by activity type + required: false + schema: + type: string + enum: + - send + - open + - click + - name: query[createdOn][from] + in: query + description: >- + Search newsletter activities from this date. Default value is 14 + days earlier. You can get activities for last 30 days only. + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search newsletter activities to this date. Default value is now + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/NewsletterActivities' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/newsletterId' + /newsletters/{newsletterId}/cancel: + post: + tags: + - Newsletters + summary: Cancel sending the newsletter + description: > + > + + Using this method, you can cancel the sending of the newsletter. It will + also turn the newsletter into a **draft**. + operationId: cancelMessageSend + responses: + '200': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: CancelNewsletter + x-no-body: true + parameters: + - $ref: '#/components/parameters/newsletterId' + /newsletters/{newsletterId}/thumbnail: + get: + tags: + - Newsletters + summary: Get newsletter thumbnail + operationId: getNewsletterThumbnail + parameters: + - name: size + in: query + description: The size of the thumbnail + required: false + schema: + type: string + default: default + enum: + - default + - small + responses: + '200': + description: The newsletter thumbnail. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + image/*: + schema: + type: string + format: binary + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: get + x-operation-class-name: GetNewsletterThumbnail + parameters: + - $ref: '#/components/parameters/newsletterId' + /newsletters/{newsletterId}/statistics: + get: + tags: + - Newsletters + summary: The statistics of single newsletter + description: >- + > + + This makes it possible to easily fetch statistics for a single + newsletter. You can group the data hourly, daily, monthly and as a + + total sum. Remember that all statistics date ranges are given in + standard UTC period type objects. + + ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)). + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getSingleNewsletterStatistics + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SingleMessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetNewsletterStatistics + parameters: + - $ref: '#/components/parameters/newsletterId' + /tags/{tagId}: + get: + tags: + - Tags + summary: Get tag by ID + operationId: getTagById + parameters: + - name: tagId + in: path + description: The tag ID + required: true + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TagDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Tags + summary: Update tag by ID + operationId: updateTag + requestBody: + $ref: '#/components/requestBodies/UpdateTag' + responses: + '200': + $ref: '#/components/responses/TagDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Tags + summary: Delete tag by ID + operationId: deleteTag + responses: + '204': + description: Tag deleted successfully. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/tagId' + /addresses/{addressId}: + get: + tags: + - Addresses + summary: Get an address by ID + description: '' + operationId: getAddress + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AddressDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Addresses + summary: Update address + description: > + + Update an existing address. You should send only those fields that need + to be changed. The rest of the properties will stay the same. + operationId: updateAddress + requestBody: + $ref: '#/components/requestBodies/UpdateAddress' + responses: + '200': + $ref: '#/components/responses/AddressDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Addresses + summary: Delete address + description: '' + operationId: deleteAddress + responses: + '204': + description: Empty response + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/addressId' + /campaigns/{campaignId}/blocklists: + get: + tags: + - Campaigns (Lists) + summary: Returns campaign blocklist masks + operationId: getCampaignBlocklist + parameters: + - name: query[mask] + in: query + description: Blocklist mask to search for + required: false + schema: + type: string + example: '@somedomain.com' + responses: + '200': + $ref: '#/components/responses/CampaignBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Campaigns (Lists) + summary: Updates campaign blocklist masks + operationId: updateCampaignBlocklist + parameters: + - name: additionalFlags + in: query + description: >- + The flag value `add` adds the masks provided in the request body to + your blocklist. The flag value `delete` deletes the masks. The masks + are replaced if there are no flag values in the request body. + + For better performance, use the flag value `noResponse`. It removes the response body and can be used alone or combined with other flags. If multiple flags are used, separate them by a comma, like this: `additionalFlags=noResponse` or `additionalFlags=add,noResponse`. + required: false + schema: + type: string + enum: + - add + - delete + - noResponse + requestBody: + $ref: '#/components/requestBodies/UpdateCampaignBlocklist' + responses: + '200': + $ref: '#/components/responses/CampaignBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: update + parameters: + - $ref: '#/components/parameters/campaignId' + /custom-fields/{customFieldId}: + get: + tags: + - Custom Fields + summary: Get a single custom field definition by the custom field ID + operationId: getCustomFieldById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/CustomFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Custom Fields + summary: Update the custom field definition + operationId: updateCustomField + requestBody: + $ref: '#/components/requestBodies/UpdateCustomField' + responses: + '200': + $ref: '#/components/responses/CustomFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Custom Fields + summary: Delete a single custom field definition + operationId: deleteCustomField + responses: + '204': + description: Delete a custom field. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/customFieldId' + /lps/{lpsId}: + get: + tags: + - Landing Pages + summary: Get a single landing page by ID + operationId: getLpsById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LpsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/lpsId' + /statistics/lps/{lpsId}/performance: + get: + tags: + - Landing Page + summary: Get details for landing page statistics + operationId: getLpsGeneralPerformanceStats + parameters: + - name: query[date][from] + in: query + description: Show a single landing page statistics from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[date][to] + in: query + description: Show a single landing page statistics to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[location] + in: query + description: Landing page statistics by location + required: false + schema: + type: string + - name: query[device] + in: query + description: Landing page statistics by device + required: false + schema: + type: string + enum: + - desktop + - mobile + - name: query[page] + in: query + description: Landing page statistics by page UUID + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LpsStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/lpsId' + /shops/{shopId}/products/{productId}/variants: + get: + tags: + - Product Variants + summary: Get a list of product variants + description: >+ + + Sending a **GET** request to this URL returns a collection of product + variant resources that belong to the given shop and product. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + + * sku + + * description + + + The `description` fields can be a pattern and we'll try to match this + phrase. + + operationId: getProductVariantList + parameters: + - name: query[name] + in: query + description: Search variant by name + required: false + schema: + type: string + - name: query[sku] + in: query + description: Search variant by SKU + required: false + schema: + type: string + - name: query[description] + in: query + description: Search variant by description + required: false + schema: + type: string + - name: query[externalId] + in: query + description: Search variant by external ID + required: false + schema: + type: string + - name: query[createdAt][from] + in: query + description: Show variants starting from this date + required: false + schema: + type: string + format: date-time + - name: query[createdAt][to] + in: query + description: Show variants starting to this date + required: false + schema: + type: string + format: date-time + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ProductVariantList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Product Variants + summary: Create product variant + description: >+ + + Sending a **POST** request to this URL will create a new product variant + resource. + + + In order to create a new product variant, you need to send a product + variant resource in the body of the request (remember that you need to + serialize the body into a JSON string) + + + There is no need to create every element (like: image, meta field, tax) + one by one by their own endpoints. All these elements can be created + during this method. + + operationId: createProductVariant + requestBody: + $ref: '#/components/requestBodies/NewProductVariant' + responses: + '201': + $ref: '#/components/responses/ProductVariantDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + /shops/{shopId}/products/{productId}/variants/{variantId}: + get: + tags: + - Product Variants + summary: Get a single product variant by ID + description: >+ + + This method returns product variant according to the given `variantId` + in the context of a given `shopId` and `productId` + + operationId: getProductVariantById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/ProductVariantDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Product Variants + summary: Update product variant + description: >+ + + Update properties of a product variant. You should send only those + fields that need to be changed. The remaining properties will stay the + same. However, when updating metafields, images, and taxes, you need to + send entire collections. Individual fields can't be updated. If you want + to update particular metafields or tax resources, you can do so using + their particular endpoints, i.e: + + * taxes - `POST /v3/shops/{shopId}/taxes/{taxId}` + * metaFields - `POST /v3/shops/{shopId}/meta-fields/{metaFieldId}` + + operationId: updateProductVariant + requestBody: + $ref: '#/components/requestBodies/UpdateProductVariant' + responses: + '200': + $ref: '#/components/responses/ProductVariantDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Product Variants + summary: Delete product variant + description: '' + operationId: deleteProductVariant + responses: + '204': + description: Delete product variant + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/productId' + - $ref: '#/components/parameters/variantId' + /campaigns/{campaignId}: + get: + tags: + - Campaigns (Lists) + summary: Get a single campaign by the campaign ID + operationId: getCampaign + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/Campaign' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Campaigns (Lists) + summary: Update a campaign + operationId: updateCampaign + requestBody: + $ref: '#/components/requestBodies/UpdateCampaign' + responses: + '200': + $ref: '#/components/responses/Campaign' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/campaignId' + /shops/{shopId}/meta-fields: + get: + tags: + - Meta Fields + summary: Get the shop meta fields + description: >- + + Sending a **GET** request to this URL returns a collection of meta field + resources that belong to the given shop. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + * value + * description + * createdOn + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getMetaFields + parameters: + - name: query[name] + in: query + description: Search meta fields by name + required: false + schema: + type: string + - name: query[description] + in: query + description: Search meta fields by description + required: false + schema: + type: string + - name: query[value] + in: query + description: Search meta fields by value + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search meta fields created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search meta fields created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MetaFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Meta Fields + summary: Create meta field + description: > + + Sending a **POST** request to this URL will create a new meta field + resource. + + + In order to create a new meta field, you need to send a meta field + resource in the body of the request (remember that you need to serialize + the body into a JSON string) + operationId: createMetaField + requestBody: + $ref: '#/components/requestBodies/NewMetaField' + responses: + '201': + $ref: '#/components/responses/MetaFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + /shops/{shopId}/meta-fields/{metaFieldId}: + get: + tags: + - Meta Fields + summary: Get the meta field by ID + description: > + + This method returns meta field with a given `metaFieldId` in the context + of a given `shopId` + operationId: getMetaField + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/MetaFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Meta Fields + summary: Update meta field + description: > + + Update the properties of a shop's meta field. You should send only those + fields that need to be changed. The rest of the properties will stay the + same. + operationId: updateMetaField + requestBody: + $ref: '#/components/requestBodies/UpdateMetaField' + responses: + '200': + $ref: '#/components/responses/MetaFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Meta Fields + summary: Delete meta field + description: '' + operationId: deleteMetaField + responses: + '204': + description: Delete meta field + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/shopId' + - $ref: '#/components/parameters/metaFieldId' + /webforms/{webformId}: + get: + tags: + - Legacy Forms + summary: Get Legacy Form by ID. + description: Get Legacy Form by ID. + operationId: getLegacyFormById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/LegacyForm' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/webformId' + /gdpr-fields/{gdprFieldId}: + get: + tags: + - GDPR Fields + summary: Get GDPR Field details + operationId: getGDPRField + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/GDPRFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/gdprFieldId' + /workflow/{workflowId}: + get: + tags: + - Workflows + summary: Get workflow by ID + description: Get a single workflow by ID. + operationId: getWorkflow + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/Workflow' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Workflows + summary: Update workflow + description: Update single workflow. + operationId: updateWorkflow + requestBody: + $ref: '#/components/requestBodies/UpdateWorkflow' + responses: + '200': + $ref: '#/components/responses/Workflow' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/workflowId' + /sms/{smsId}: + get: + tags: + - SMS Messages + summary: Get a single SMS message by its ID + operationId: getSmsById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SmsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + parameters: + - $ref: '#/components/parameters/smsId' + /autoresponders/{autoresponderId}: + get: + tags: + - Autoresponders + summary: Get a single autoresponder by its ID + operationId: getAutoresponder + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AutoresponderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Autoresponders + summary: Update autoresponder + description: > + > + + **The action-based autoresponder feature has been migrated over to + marketing automation. Your existing autoresponders are + + now converted into workflows. You can no longer create and update + action-based autoresponders using our API.** + + + This method allows you to update an autoresponder. The same rules as in + creating an autoresponder apply. + operationId: updateAutoresponder + requestBody: + $ref: '#/components/requestBodies/UpdateAutoresponder' + responses: + '200': + $ref: '#/components/responses/AutoresponderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + delete: + tags: + - Autoresponders + summary: Delete autoresponder. + operationId: deleteAutoresponder + responses: + '204': + description: Delete autoresponder + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/autoresponderId' + /autoresponders/{autoresponderId}/thumbnail: + get: + tags: + - Autoresponders + summary: Get the autoresponder thumbnail + operationId: getAutoresponderThumbnail + parameters: + - name: size + in: query + description: The size of the autoresponder thumbnail + required: false + schema: + type: string + default: default + enum: + - default + - small + responses: + '200': + description: The autoresponder thumbnail. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + image/*: + schema: + type: string + format: binary + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: get + x-operation-class-name: GetAutoresponderThumbnail + parameters: + - $ref: '#/components/parameters/autoresponderId' + /autoresponders/{autoresponderId}/statistics: + get: + tags: + - Autoresponders + summary: The statistics for a single autoresponder + description: >- + > + + This requst returns the statistics summary for a single given + autoresponder. As in all statistics, you can change the date and time + range (hourly daily monthly or total). Keep in mind + + that all statistics date ranges are given in standard UTC period type + objects. ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)) + + + (https://app.getresponse.com/statistics.html?t=followup#total). + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getSingleAutoresponderStatistics + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SingleMessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetAutoresponderStatistics + parameters: + - $ref: '#/components/parameters/autoresponderId' + /websites/{websiteId}: + get: + tags: + - Websites + summary: Get a single Website by ID + operationId: getWebsiteById + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/WebsiteDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/websiteId' + /statistics/wbe/{websiteId}/performance: + get: + tags: + - Website + summary: Get details for website statistics + operationId: getWbeGeneralPerformanceStats + parameters: + - name: query[date][from] + in: query + description: Show a single website statistics from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[date][to] + in: query + description: Show a single website statistics to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[location] + in: query + description: Website statistics by location + required: false + schema: + type: string + - name: query[device] + in: query + description: Website statistics by device + required: false + schema: + type: string + enum: + - desktop + - mobile + - name: query[page] + in: query + description: Website statistics by a page UUID + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/WebsiteStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + parameters: + - $ref: '#/components/parameters/websiteId' + /webinars: + get: + tags: + - Webinars + summary: Get a list of webinars + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getWebinarList + parameters: + - name: query[name] + in: query + description: Search webinars by name + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: The list of campaign resource IDs (string separated with ',') + required: false + schema: + type: string + - name: query[status] + in: query + description: Search webinars by status + required: false + schema: + type: string + enum: + - upcoming + - finished + - published + - unpublished + - name: sort[name] + in: query + description: Sort webinars by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort webinars by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[startsOn] + in: query + description: Sort webinars by update date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: query[type] + in: query + description: Search webinars by type + required: false + schema: + type: string + enum: + - all + - live + - on_demand + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/WebinarList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /contacts: + get: + tags: + - Contacts + summary: Get contact list + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getContactList + parameters: + - name: query[email] + in: query + description: Search contacts by email + required: false + schema: + type: string + - name: query[name] + in: query + description: Search contacts by name + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: Search contacts by campaign ID + required: false + schema: + type: string + - name: query[origin] + in: query + description: Search contacts by origin + required: false + schema: + type: string + enum: + - import + - email + - www + - panel + - leads + - sale + - api + - forward + - survey + - iphone + - copy + - landing_page + - webinar + - website_builder_elegant + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[changedOn][from] + in: query + description: Search contacts edited from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[changedOn][to] + in: query + description: Search contacts edited to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[email] + in: query + description: Sort by email + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[changedOn] + in: query + description: Sort by change date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[campaignId] + in: query + description: Sort by campaign ID + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: additionalFlags + in: query + description: >- + The additional flags parameter with the value 'exactMatch' will + search for contacts with the exact value of the email and name + provided in the query string. Without this flag, matching is done + via a standard 'like' comparison, which may sometimes be slow. + required: false + schema: + type: string + x-set: + - exactMatch + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ContactList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Contacts + summary: Create a new contact + operationId: createContact + requestBody: + $ref: '#/components/requestBodies/NewContact' + responses: + '202': + description: >- + > + + If the request is successful, the API returns the HTTP code **202 + Accepted**. + + This means that the contact has been preliminarily validated and + added to the queue. + + It may take a few minutes to process the queue and add the contact + to the list. If your contact didn't appear on the list, there's a + possibility that it was rejected at a later stage of processing. + + + ### Double opt-in + + + Campaigns can be set to double opt-in. + + This means that the contact has to click a link in a confirmation + message before they can be added to your list. + + Unconfirmed contacts are not returned by the API and can only be + found using Search Contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /contacts/batch: + post: + tags: + - Contacts + summary: Create multiple contacts at once + description: >- + This endpoint lets you create multiple contacts in one request. + + + **Note** + + + This endpoint is subject to special limits and throttling. You can make + 80 calls per time frame (10 minutes). The allowed batch size is 1000 + contacts. For more information, check our [API + Docs](https://apidocs.getresponse.com/v3/case-study/adding-batch-contacts). + operationId: createBatchContacts + requestBody: + content: + application/json: + schema: + required: + - campaignId + - contacts + properties: + campaignId: + description: ID of the destination campaign (list). + type: string + example: C + contacts: + description: Contacts that will be created. + type: array + items: + required: + - email + properties: + email: + type: string + format: email + example: john.doe@example.com + name: + type: string + maxLength: 128 + minLength: 1 + example: John Doe + dayOfCycle: + description: The day a contact is on in an autoresponder cycle. + type: string + example: '42' + scoring: + description: Contact's score + type: number + example: 8 + ipAddress: + description: >- + Contact's IP address. IPv4 and IPv6 formats are + accepted. + example: 1.2.3.4 + oneOf: + - type: string + format: ipv4 + - type: string + format: ipv6 + tags: + required: + - ids + properties: + ids: + description: List of tag IDs. + type: array + items: + type: string + example: kL6Nh + type: object + customFieldValues: + type: array + items: + required: + - customFieldId + - value + properties: + customFieldId: + description: Custom field ID. + type: string + example: kL6Nh + value: + type: array + items: + type: string + example: 18-35 + type: object + type: object + type: object + responses: + '202': + description: >- + > + + If the request is successful, the API returns the HTTP code **202 + Accepted**. + + This means that the contacts has been preliminarily validated and + added to the queue. + + It may take a few minutes to process the queue and add the contacts + to the list. If your contact doesn't appear on the list, they were + likely rejected during the late processing stages. + + + ### Double opt-in + + + Campaigns (lists) can be set to use double opt-in. + + This means that a contact has to click a link in a confirmation + message before they can be added to your list. + + Unconfirmed contacts are not returned by API and can only be found + using Search Contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /search-contacts: + get: + tags: + - Search Contacts + summary: Get a saved search contact list + description: >- + Makes it possible to retrieve a collection of short representations of + search-contact (known as custom filters in the panel). Every item + represents a basic filter object. You can filter the resource using + criteria specified as `query[*]`. You can provide multiple criteria, to + use AND logic. You can sort the resource using parameters specified as + `sort[*]`. You can specify multiple fields to sort by. + operationId: getSearchContactsList + parameters: + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - name: sort[createdOn] + in: query + description: Sort by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: asc + - name: query[name] + in: query + description: Search by name + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/BaseSearchContactsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Search Contacts + summary: Create search contacts + description: >- + Makes it possible to create a new search-contact. Please refer to + [Segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual) + operationId: newSearchContacts + requestBody: + $ref: '#/components/requestBodies/NewSearchContacts' + responses: + '201': + $ref: '#/components/responses/SearchContactsDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /search-contacts/contacts: + post: + tags: + - Search Contacts + summary: Search contacts using conditions + description: >- + Makes it possible to get a collection of contacts according to a given + condition. Please refer to [Segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual) + operationId: getContactsFromSearchContactsConditions + parameters: + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - name: sort[email] + in: query + description: Sort by email + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: desc + - name: sort[createdOn] + in: query + description: Sort by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: asc + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + requestBody: + $ref: '#/components/requestBodies/SearchContactsConditionsDetails' + responses: + '200': + $ref: '#/components/responses/SearchedContactsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetContactsBySearchContactsConditions + /transactional-emails/templates: + get: + tags: + - Transactional Emails Templates + summary: Get the list of transactional email templates + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getTransactionalEmailsTemplatesList + parameters: + - name: query[subject] + in: query + description: Search templates by subject + required: false + schema: + type: string + - name: sort[createdOn] + in: query + description: Sort by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subject] + in: query + description: Sort by template subject + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailsTemplateList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + post: + tags: + - Transactional Emails Templates + summary: Create transactional email template + description: This method creates a new transactional email template + operationId: createTransactionalEmailTemplate + requestBody: + $ref: '#/components/requestBodies/CreateTransactionalEmailTemplate' + responses: + '201': + $ref: '#/components/responses/TransactionalEmailsTemplateDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /transactional-emails: + get: + tags: + - Transactional Emails + summary: Get the list of transactional emails + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getTransactionalEmailsList + parameters: + - name: query[sentOn][from] + in: query + description: Search transactional emails sent from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[sentOn][to] + in: query + description: Search transactional emails sent to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[tagged] + in: query + description: Search tagged/untagged transactional emails + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - name: query[tagId] + in: query + description: Search transactional emails with a specific tag ID + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + post: + tags: + - Transactional Emails + summary: Send transactional email + operationId: createTransactionalEmail + requestBody: + $ref: '#/components/requestBodies/CreateTransactionalEmail' + responses: + '201': + $ref: '#/components/responses/TransactionalEmail' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /transactional-emails/statistics: + get: + tags: + - Transactional Emails + summary: Get the overall statistics of transactional emails + operationId: getTransactionalEmailsStatistics + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: true + schema: + type: string + enum: + - total + - day + - name: query[timeFrame][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[timeFrame][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[tagged] + in: query + description: Search tagged/untagged transactional emails + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - name: query[tagId] + in: query + description: Search transactional emails with a specific tag ID + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/TransactionalEmailStatistics' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /from-fields: + get: + tags: + - From Fields + summary: Get the list of 'From' addresses + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getFromFieldList + parameters: + - name: query[email] + in: query + description: Search 'From' address by email + required: false + schema: + type: string + - name: query[name] + in: query + description: Search 'From' address by name + required: false + schema: + type: string + format: date + - name: query[isDefault] + in: query + description: Search only default 'From' address + required: false + schema: + type: boolean + example: true + - name: query[isActive] + in: query + description: Search only active 'From' addresses + required: false + schema: + type: boolean + example: true + - name: sort[createdOn] + in: query + description: Sort 'From' address by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FromFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - From Fields + summary: Create 'From' address + operationId: createFromField + requestBody: + $ref: '#/components/requestBodies/NewFromField' + responses: + '201': + $ref: '#/components/responses/FromFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /rss-newsletters: + get: + tags: + - RSS Newsletters + summary: Get the list of RSS newsletters + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getRssNewslettersList + parameters: + - name: query[subject] + in: query + description: Search RSS newsletters by subject + required: false + schema: + type: string + - name: query[status] + in: query + description: Search RSS newsletters by status + required: false + schema: + type: string + enum: + - enabled + - disabled + - name: query[createdOn][from] + in: query + description: Search RSS newsletters created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search RSS newsletters created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[campaignId] + in: query + description: Search RSS newsletters by campaign ID + required: false + schema: + type: string + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/RssNewsletterList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - RSS Newsletters + summary: Create RSS newsletter + operationId: createRssNewsletter + requestBody: + $ref: '#/components/requestBodies/NewRssNewsletter' + responses: + '201': + $ref: '#/components/responses/RssNewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /rss-newsletters/statistics: + get: + tags: + - RSS Newsletters + summary: The statistics for all RSS newsletters + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getRssNewsletterStatisticsCollection + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[rssNewsletterId] + in: query + description: The list of RSS newsletter resource IDs (string separated with ',') + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: The list of campaign resource IDs (string separated with ',') + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetRssNewslettersStatistics + /custom-events: + get: + tags: + - Custom Events + summary: Get a list of custom events + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getCustomEventsList + parameters: + - name: query[name] + in: query + description: Search custom events by name + required: false + schema: + type: string + - name: query[hasAttributes] + in: query + description: Search custom events with or without attributes + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CustomEventsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Custom Events + summary: Create custom event + operationId: createCustomEvent + requestBody: + $ref: '#/components/requestBodies/NewCustomEvent' + responses: + '201': + $ref: '#/components/responses/CustomEventDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /custom-events/trigger: + post: + tags: + - Custom Events + summary: Trigger a custom event + operationId: triggerCustomEvent + requestBody: + $ref: '#/components/requestBodies/TriggerCustomEvent' + responses: + '201': + description: Empty response + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: TriggerCustomEvent + /forms: + get: + tags: + - Forms + summary: Get the list of forms. + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getFormList + parameters: + - name: query[name] + in: query + description: Search forms by name + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search forms created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search forms created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[campaignId] + in: query + description: >- + Search forms assigned to this list (campaign). You can pass multiple + comma-separated values, eg. `Xd1P,sC7r` + required: false + schema: + type: string + - name: query[status] + in: query + description: >- + Search by status. **Note:** `disabled` includes both `unpublished` + and `draft` and `enabled` equals `published` + required: false + schema: + type: string + enum: + - enabled + - disabled + - published + - unpublished + - draft + - name: sort[createdOn] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[visitors] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[uniqueVisitors] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subscribed] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subscriptionRate] + in: query + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FormList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /landing-pages: + get: + tags: + - Legacy Landing Pages + summary: Get a list of landing pages + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getLandingPageList + parameters: + - name: query[domain] + in: query + description: Search landing pages by domain + required: false + schema: + type: string + - name: query[status] + in: query + description: Search landing pages by status + required: false + schema: + $ref: '#/components/schemas/StatusEnum' + - name: query[subdomain] + in: query + description: Search landing pages by subdomain + required: false + schema: + type: string + - name: query[metaTitle] + in: query + description: Search landing pages by metaTitle field + required: false + schema: + type: string + - name: query[userDomain] + in: query + description: Search landing pages by user provided domain + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: >- + Search landing pages by ID of the assigned campaign. Campaign ID + must be encoded! You can get the campaign list with encoded IDs by + calling the `/v3/campaigns` endpoint. You can search by multiple + comma separated values eg. `o5lx,34er`. + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Show landing pages created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Show landing pages created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[domain] + in: query + description: Sort by domain + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[campaignId] + in: query + description: Sort by campaign + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[metaTitle] + in: query + description: Sort by metaTitle + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/LandingPageList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /imports: + get: + tags: + - Imports + summary: Get a list of imports. + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getImportList + parameters: + - name: query[campaignId] + in: query + description: Search imports by campaignId + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search imports created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search imports created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort imports by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[finishedOn] + in: query + description: Sort imports by finish date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[campaignName] + in: query + description: Sort imports by campaign name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[uploadedContacts] + in: query + description: Sort imports by uploaded contact count + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[updatedContacts] + in: query + description: Sort imports by updated contact count + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[addedContacts] + in: query + description: Sort imports by inserted contact count + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[invalidContacts] + in: query + description: Sort imports by invalid contact count + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[status] + in: query + description: >- + Sort imports by status (uploaded, to_review, approved, finished, + rejected, canceled) + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ImportList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Imports + summary: Schedule a new contact import + description: >- + This endpoint lets you schedule a contact import. That way, you can add + and update your contacts using a single API call. Since API imports are + asynchronous, you should check periodically for updates while your + original API request is being processed. To keep track of your import + status, use [GET + import](https://apireference.getresponse.com/#operation/getImportById) + (provide the importId from the response), or subscribe to an [import + finished](https://apidocs.getresponse.com/v3/payloads#contacts-import-finished) + webhook. For more information on imports, check our [API + Docs](https://apidocs.getresponse.com/v3/case-study/create-import) or + [Help + Center](https://www.getresponse.com/help/how-do-i-prepare-a-file-for-import.html) + operationId: createImport + requestBody: + $ref: '#/components/requestBodies/NewImport' + responses: + '201': + $ref: '#/components/responses/ImportDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /statistics/ecommerce/revenue: + get: + tags: + - Ecommerce + summary: Get the ecommerce revenue statistics + operationId: getRevenueStats + parameters: + - name: query[orderDate][from] + in: query + description: Show statistics for orders from this date + required: false + schema: + type: string + format: date + - name: query[orderDate][to] + in: query + description: Show statistics for orders to this date + required: false + schema: + type: string + format: date + - name: query[shopId] + in: query + description: >- + Search statistics by shop ID. You can get the shop ID by calling the + `/v3/shops` endpoint. You can search for multiple shops using + comma-separated values, for example, `pgIH, CNXF` + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/RevenueStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /statistics/ecommerce/performance: + get: + tags: + - Ecommerce + summary: Get the ecommerce general performance statistics + operationId: getGeneralPerformanceStats + parameters: + - name: query[orderDate][from] + in: query + description: Show statistics for orders from this date + required: false + schema: + type: string + format: date + - name: query[orderDate][to] + in: query + description: Show statistics for orders to this date + required: false + schema: + type: string + format: date + - name: query[shopId] + in: query + description: >- + Search statistics by shop ID. You can get the shop ID by calling the + `/v3/shops` endpoint. You can search for multiple shops using + comma-separated values, for example, `pgIH, CNXF` + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/GeneralPerformanceStats' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /predefined-fields: + get: + tags: + - Predefined Fields + summary: Get the predefined fields list + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getPredefinedFieldList + parameters: + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + example: DESC + - name: query[name] + in: query + description: Search by name + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: Search by campaign ID + required: false + schema: + type: string + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/PredefinedFieldsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Predefined Fields + summary: Create a predefined field + description: Makes it possible to create a new predefined field. + operationId: createPredefinedField + requestBody: + $ref: '#/components/requestBodies/NewPredefinedField' + responses: + '201': + $ref: '#/components/responses/PredefinedFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /suppressions: + get: + tags: + - Suppressions + summary: Get suppression lists + operationId: getSuppressionsList + parameters: + - name: query[name] + in: query + description: Search suppressions by name + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search suppressions created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search suppressions created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by the createdOn date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SuppressionsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Suppressions + summary: Creates a new suppression list + operationId: createSuppression + requestBody: + description: The suppression list to be added. + $ref: '#/components/requestBodies/NewSuppression' + responses: + '201': + $ref: '#/components/responses/SuppressionDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /subscription-confirmations/body/{languageCode}: + get: + tags: + - Subscription Confirmations + summary: Get collection of SUBSCRIPTION CONFIRMATIONS bodies + description: >+ + + Sending **GET** request to this url, returns collection of + **SUBSCRIPTION CONFIRMATIONS** bodies. + + + Language code used in url must be in ISO 639-1 Language Code Standard. + + operationId: getSubscriptionConfirmationBodyList + parameters: + - $ref: '#/components/parameters/languageCode' + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SubscriptionConfirmationBodyList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /subscription-confirmations/subject/{languageCode}: + get: + tags: + - Subscription Confirmations + summary: Get collection of SUBSCRIPTION CONFIRMATIONS subjects + description: >+ + + Sending **GET** request to this url, returns collection of + **SUBSCRIPTION CONFIRMATIONS** subjects. + + + Language code used in url must be in ISO 639-1 Language Code Standard. + + operationId: getSubscriptionConfirmationSubjectList + parameters: + - $ref: '#/components/parameters/languageCode' + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SubscriptionConfirmationSubjectList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /shops: + get: + tags: + - Shops + summary: Get a list of shops + description: >- + + Sending a **GET** request to this URL returns a collection of shop + resources. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + + The `name` fields can be a pattern and we'll try to match this phrase. + + + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getShopList + parameters: + - name: query[name] + in: query + description: Search shop by name + required: false + schema: + type: string + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ShopList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Shops + summary: Create shop + description: |+ + + This method makes it possible to create a new shop. + + operationId: createShop + requestBody: + $ref: '#/components/requestBodies/NewShop' + responses: + '201': + $ref: '#/components/responses/ShopDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /popups: + get: + tags: + - Forms and Popups + summary: Get the list of forms and popups + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getPopupsList + parameters: + - name: query[name] + in: query + description: Search forms and popups by name + required: false + schema: + type: string + - name: query[status] + in: query + description: Search forms and popups by status + required: false + schema: + type: string + enum: + - published + - unpublished + - name: stats[from] + in: query + description: Show statistics from this date + required: false + schema: + type: string + format: date-time + - name: stats[to] + in: query + description: Show statistics to this date + required: false + schema: + type: string + format: date-time + - name: sort[name] + in: query + description: Sort forms and popups by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[status] + in: query + description: Sort forms and popups by status + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdAt] + in: query + description: Sort forms and popups by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[updatedAt] + in: query + description: Sort forms and popups by modification date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[views] + in: query + description: Sort by number of views + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[uniqueVisitors] + in: query + description: Sort by number of unique visitors + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[leads] + in: query + description: Sort by number of leads + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[ctr] + in: query + description: Sort by CTR (click-through rate) + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/PopupsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /splittests: + get: + tags: + - A/B tests + summary: The list of A/B tests. + description: >- + The list of A/B tests. You can filter the resource using criteria + specified as `query[*]`. You can provide multiple criteria, to use AND + logic. You can sort the resource using parameters specified as + `sort[*]`. You can specify multiple fields to sort by. + operationId: getSplittestList + parameters: + - name: query[name] + in: query + description: Search A/B tests by name + required: false + schema: + type: string + - name: query[type] + in: query + description: Search A/B tests by type + required: false + schema: + type: string + - name: query[status] + in: query + description: Search A/B tests by status + required: false + schema: + type: string + default: active + enum: + - active + - inactive + - name: query[createdOn][from] + in: query + description: Search A/B tests created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search A/B tests created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SplittestList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /file-library/quota: + get: + tags: + - File Library + summary: Get storage space information + operationId: quota + responses: + '200': + $ref: '#/components/responses/Quota' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /file-library/files: + get: + tags: + - File Library + summary: Get the list of files + description: >- + By default, you can only search files in the root directory. To search + for files in all folders, use the parameter `query[allFolders]=true`. To + search for files in a specified folder, use the parameter + `query[folderId]=`. **Note: these two parameters can't be used + together**. You can filter the resource using criteria specified as + `query[*]`. You can provide multiple criteria, to use AND logic. You can + sort the resource using parameters specified as `sort[*]`. You can + specify multiple fields to sort by. + operationId: getFileList + parameters: + - name: query[allFolders] + in: query + description: >- + Return files from all folders, including the root folder. **This + parameter can't be used together with ** `query[folderId]` + required: false + schema: + $ref: '#/components/schemas/StringBooleanEnum' + - name: query[folderId] + in: query + description: >- + Search for files in a specific folder. **This parameter can't be + used together with ** `query[allFolders]` + required: false + schema: + type: string + - name: query[name] + in: query + description: Search for files by name + required: false + schema: + type: string + - name: query[group] + in: query + description: Search for files by group + required: false + schema: + $ref: '#/components/schemas/FileGroup' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[group] + in: query + description: Sort files by group + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[size] + in: query + description: Sort files by size + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FileList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - File Library + summary: Create a file + operationId: createFile + requestBody: + $ref: '#/components/requestBodies/NewFile' + responses: + '201': + $ref: '#/components/responses/File' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /file-library/folders: + get: + tags: + - File Library + summary: Get the list of folders + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getFolderList + parameters: + - name: query[name] + in: query + description: Search folders by name + required: false + schema: + type: string + - name: sort[name] + in: query + description: Sort folders by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[size] + in: query + description: Sort folders by size + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort folders by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/FoldersList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - File Library + summary: Create a folder + operationId: createFolder + requestBody: + $ref: '#/components/requestBodies/NewFolder' + responses: + '201': + $ref: '#/components/responses/Folder' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /ab-tests/subject: + get: + tags: + - A/B tests - subject + summary: The list of A/B tests + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: AbtestsSubjectGetList + parameters: + - name: query[name] + in: query + description: Search A/B tests by name + required: false + schema: + type: string + - name: query[stage] + in: query + description: Search A/B tests by stage + required: false + schema: + type: string + enum: + - preparing + - testing + - finished + - sending-winner + - cancelled + - draft + - completed + - name: query[abTestId] + in: query + description: Search A/B tests by ID + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: Search A/B tests by list ID + required: false + schema: + type: string + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[stage] + in: query + description: Sort by stage + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[sendOn] + in: query + description: Sort by send date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[totalDelivered] + in: query + description: Sort by total delivered + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AbtestsSubjectGetList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - A/B tests - subject + summary: Create a new A/B test + operationId: postAbtestsSubjectById + requestBody: + $ref: '#/components/requestBodies/NewAbtestsSubject' + responses: + '201': + $ref: '#/components/responses/AbtestsSubjectGetDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /click-tracks: + get: + tags: + - Click Tracks + summary: Get click tracked links list + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getClickTrackList + parameters: + - name: query[createdOn][from] + in: query + description: Search click tracks from messages created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search click tracks from messages created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdOn] + in: query + description: Sort by message date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ClickTrackList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /newsletters: + get: + tags: + - Newsletters + summary: Get the newsletter list + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getNewsletterList + parameters: + - name: query[subject] + in: query + description: Search newsletters by subject + required: false + schema: + type: string + - name: query[name] + in: query + description: Search newsletters by name + required: false + schema: + type: string + - name: query[status] + in: query + description: Search newsletters by status + required: false + schema: + type: string + enum: + - enabled + - disabled + - name: query[createdOn][from] + in: query + description: Search newsletters created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search newsletters created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[sendOn][from] + in: query + description: Search for newsletters sent from this date + required: false + schema: + type: string + format: date + example: '2023-01-20' + - name: query[sendOn][to] + in: query + description: Search for newsletters sent to this date + required: false + schema: + type: string + format: date + example: '2023-01-20' + - name: query[type] + in: query + description: Search newsletters by type + required: false + schema: + type: string + enum: + - draft + - broadcast + - splittest + - automation + - name: query[campaignId] + in: query + description: Search newsletters by campaign ID + required: false + schema: + type: string + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[sendOn] + in: query + description: Sort by send on date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/NewsletterList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Newsletters + summary: Create newsletter + description: | + > + This method creates a new newsletter and puts it in a queue to send. + + **NOTE: This method has a limit of 256 calls per day.** + operationId: createNewsletter + requestBody: + $ref: '#/components/requestBodies/NewNewsletter' + responses: + '201': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 404 + code: 1013 + codeDescription: The requested resource was not found + message: Resource not found + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1013 + context: + contactId: pVyRW + uuid: 87b90a96-5ee5-4ca4-8180-ac00adcf62c7 + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /newsletters/send-draft: + post: + tags: + - Newsletters + summary: Send the newsletter draft + operationId: sendDraft + requestBody: + $ref: '#/components/requestBodies/SendNewsletterDraft' + responses: + '201': + $ref: '#/components/responses/NewsletterDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: SendNewsletterDraft + /newsletters/statistics: + get: + tags: + - Newsletters + summary: Total newsletter statistics + description: >- + >This makes it possible to fetch newsletter statistics based on the list + of campaign or newsletter IDs + + (you can pass them in the query parameter - see the description below). + Remember that all the statistics date ranges + + are returned in standard UTC period type objects. ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)). You + can filter the resource using criteria specified as `query[*]`. You can + provide multiple criteria, to use AND logic. You can sort the resource + using parameters specified as `sort[*]`. You can specify multiple fields + to sort by. + operationId: getNewsletterStatisticsCollection + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[newsletterId] + in: query + description: The list of newsletter resource IDs (string separated with '') + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: The list of campaign resource IDs (string separated with '') + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /tags: + get: + tags: + - Tags + summary: Get the list of tags + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getTagsList + parameters: + - name: query[name] + in: query + description: Search tags by name + required: false + schema: + type: string + - name: query[createdAt][from] + in: query + description: Search tags created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdAt][to] + in: query + description: Search tags created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: sort[createdAt] + in: query + description: Sort tags by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/TagList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Tags + summary: Add a new tag + operationId: createTag + requestBody: + $ref: '#/components/requestBodies/NewTag' + responses: + '201': + $ref: '#/components/responses/TagDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /addresses: + get: + tags: + - Addresses + summary: Get a list of addresses + description: >- + + Sending a **GET** request to this URL returns collection of address + resources. + + + You can narrow down the list of resources by passing proper query + parameters (the list of which you can find below in the request params + section). You can basically search by: + + * name + + * firstName + + * lastName + + * address1 + + * address2 + + * city + + * zip + + * province + + * provinceCode + + * phone + + * company + + * createdOn + + + The `name` field can be a pattern and we'll try to match this phrase. + + + You can specify which page of the results you want and how many results + per page to display. You can also specify the sort-order using one or + more of the allowed fields (listed below in the request params section). + + + Last but not least, you can even specify which fields from a resource + you want to get. If you pass the param `fields` with the list of fields + (separated by a comma [,]) we'll return the list of resources with only + those fields (we'll always add a resource ID to ensure that you can use + that data later on) + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getAddressList + parameters: + - name: query[name] + in: query + description: Search addresses by name + required: false + schema: + type: string + - name: query[firstName] + in: query + description: Search addresses by first name + required: false + schema: + type: string + - name: query[lastName] + in: query + description: Search addresses by last name + required: false + schema: + type: string + - name: query[address1] + in: query + description: Search addresses by address1 field + required: false + schema: + type: string + - name: query[address2] + in: query + description: Search addresses by address2 field + required: false + schema: + type: string + - name: query[city] + in: query + description: Search addresses by city + required: false + schema: + type: string + - name: query[zip] + in: query + description: Search addresses by ZIP + required: false + schema: + type: string + - name: query[province] + in: query + description: Search addresses by province + required: false + schema: + type: string + - name: query[provinceCode] + in: query + description: Search addresses by province code + required: false + schema: + type: string + - name: query[phone] + in: query + description: Search addresses by phone + required: false + schema: + type: string + - name: query[company] + in: query + description: Search addresses by company + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Search addresses created from this date + required: false + schema: + type: string + format: date-time + - name: query[createdOn][to] + in: query + description: Search addresses created to this date + required: false + schema: + type: string + format: date-time + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AddressList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Addresses + summary: Create address + description: '' + operationId: createAddress + requestBody: + $ref: '#/components/requestBodies/NewAddress' + responses: + '201': + $ref: '#/components/responses/AddressDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/blocklists: + get: + tags: + - Accounts + summary: Returns account blocklist masks + operationId: getAccountBlocklist + parameters: + - name: query[mask] + in: query + description: Blocklist mask to search for + required: false + schema: + type: string + example: '@somedomain.com' + responses: + '200': + $ref: '#/components/responses/AccountBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Accounts + summary: Update account blocklist + operationId: updateAccountBlocklist + parameters: + - name: additionalFlags + in: query + description: >- + The flag value `add` adds the masks provided in the request body to + your blocklist. The flag value `delete` deletes the masks. The masks + are replaced if there are no flag values in the request body. + + For better performance, use the flag value `noResponse`. It removes the response body and can be used alone or combined with other flags. If multiple flags are used, separate them by a comma, like this: `additionalFlags=noResponse` or `additionalFlags=add,noResponse`. + required: false + schema: + type: string + enum: + - add + - delete + - noResponse + requestBody: + $ref: '#/components/requestBodies/UpdateAccountBlocklist' + responses: + '200': + $ref: '#/components/responses/AccountBlocklist' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: update + /custom-fields: + get: + tags: + - Custom Fields + summary: Get a list of custom fields + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getCustomFieldList + parameters: + - name: query[name] + in: query + description: Search custom fields by name + required: false + schema: + type: string + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CustomFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Custom Fields + summary: Create a custom field + operationId: createCustomField + requestBody: + $ref: '#/components/requestBodies/NewCustomField' + responses: + '201': + $ref: '#/components/responses/CustomFieldDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /lps: + get: + tags: + - Landing Pages + summary: Get the list of landing pages + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getLpsList + parameters: + - name: query[name] + in: query + description: Search landing pages by name + required: false + schema: + type: string + - name: query[status] + in: query + description: Search landing pages by status + required: false + schema: + type: string + enum: + - published + - unpublished + - name: stats[from] + in: query + description: Show statistics for landing pages from this date + required: false + schema: + type: string + format: date-time + - name: stats[to] + in: query + description: Show statistics for landing pages to this date + required: false + schema: + type: string + format: date-time + - name: sort[name] + in: query + description: Sort landing pages by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdAt] + in: query + description: Sort landing pages by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[updatedAt] + in: query + description: Sort landing pages by modification date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[visits] + in: query + description: Sort by number of page visits + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[leads] + in: query + description: Sort landing pages by number of leads + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subscriptionRate] + in: query + description: Sort by subscription rate + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/LpsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /multimedia: + get: + tags: + - Multimedia + summary: Get images list + operationId: getImageList + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/ImageList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Multimedia + summary: Upload image + operationId: uploadImage + requestBody: + $ref: '#/components/requestBodies/CreateMultimedia' + responses: + '200': + $ref: '#/components/responses/ImageDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: CreateMultimedia + x-type: upload + /tracking: + get: + tags: + - Tracking + summary: Get Tracking JavaScript code snippets + description: >- + With code snippets you will be able to track Purchases, Abandoned carts, + and Visited URLs. Find more in our [Help + Center](https://www.getresponse.com/help/marketing-automation/ecommerce-conditions/how-do-i-add-the-tracking-javascript-code-to-my-website.html). + operationId: getTracking + responses: + '200': + $ref: '#/components/responses/Tracking' + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /tracking/facebook-pixels: + get: + tags: + - Tracking + summary: Get the list of "Facebook Pixels" + description: >- + Returns the name and ID of "Facebook Pixels" assigned to a user's + account. + operationId: getFacebookPixelList + responses: + '200': + $ref: '#/components/responses/FacebookPixelList' + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts: + get: + tags: + - Accounts + summary: Account information + operationId: getAccount + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AccountDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Accounts + summary: Update account + operationId: updateAccount + requestBody: + $ref: '#/components/requestBodies/UpdateAccount' + responses: + '200': + $ref: '#/components/responses/AccountDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: UpdateAccount + /accounts/billing: + get: + tags: + - Accounts + summary: Billing information + operationId: getAccountBilling + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AccountBillingDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/login-history: + get: + tags: + - Accounts + summary: History of logins + operationId: getAccountLoginHistory + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AccountLoginHistoryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/badge: + get: + tags: + - Accounts + summary: Current status of your GetResponse badge + operationId: getAccountBadge + responses: + '200': + $ref: '#/components/responses/AccountBadgeDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Accounts + summary: Turn on/off the GetResponse Badge + operationId: updateAccountBadge + requestBody: + $ref: '#/components/requestBodies/UpdateAccountBadge' + responses: + '200': + $ref: '#/components/responses/AccountBadgeDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-type: update + /accounts/industries: + get: + tags: + - Accounts + summary: List of Industry Tags + description: List of Industry Tags in account's language context. + operationId: getIndustries + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/IndustryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/timezones: + get: + tags: + - Accounts + summary: List of timezones + description: List of timezones in account's language context. + operationId: getTimezones + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/AccountTimezoneList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/callbacks: + get: + tags: + - Accounts + summary: Get callbacks configuration + operationId: getCallbacks + responses: + '200': + $ref: '#/components/responses/Callback' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '404': + description: Callbacks are disabled for the account + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Accounts + summary: Enable or update callbacks configuration + operationId: updateCallbacks + requestBody: + $ref: '#/components/requestBodies/UpdateCallbacks' + responses: + '200': + $ref: '#/components/responses/Callback' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: UpdateCallback + delete: + tags: + - Accounts + summary: Disable callbacks + operationId: disableCallbacks + responses: + '204': + description: Empty response + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /accounts/sending-limits: + get: + tags: + - Accounts + summary: Send limits + operationId: getSendingLimits + parameters: + - $ref: '#/components/parameters/Fields' + responses: + '200': + $ref: '#/components/responses/SendingLimitsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /campaigns: + get: + tags: + - Campaigns (Lists) + summary: Get a list of campaigns + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getCampaignList + parameters: + - name: query[name] + in: query + required: false + schema: + type: string + example: campaign_name + - name: query[isDefault] + in: query + required: false + schema: + type: boolean + example: true + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/CampaignList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Campaigns (Lists) + summary: Create a campaign + operationId: createCampaign + requestBody: + $ref: '#/components/requestBodies/NewCampaign' + responses: + '201': + $ref: '#/components/responses/Campaign' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /campaigns/statistics/origins: + get: + tags: + - Campaigns (Lists) + summary: Get subscriber origin statistics + description: The results are indexed with the campaign ID. + operationId: getCampaignStatisticsOrigins + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/CampaignOriginsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsOrigins + /campaigns/statistics/locations: + get: + tags: + - Campaigns (Lists) + summary: Get subscriber location statistics + description: The results are indexed with the location name (PL, EN, etc.). + operationId: getCampaignStatisticsLocations + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/CampaignLocationsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsLocations + /campaigns/statistics/list-size: + get: + tags: + - Campaigns (Lists) + summary: Get campaign size statistics + description: >- + Returns the number of the total added and removed subscribers, grouped + by default or by time period. + operationId: getCampaignStatisticsListSize + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/CampaignListSizesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsListSize + /campaigns/statistics/subscriptions: + get: + tags: + - Campaigns (Lists) + summary: Get the number and origin of subscription statistics + description: >- + Returns the number and origin of subscriptions, grouped by a specified + campaigns for each day on which any changes were made. Dates in the + YYYY-MM-DD format are used as keys in the response. + operationId: getCampaignStatisticsSubscriptions + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/SubscriptionsByDatesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsSubscriptions + /campaigns/statistics/removals: + get: + tags: + - Campaigns (Lists) + summary: Get removal statistics + description: >- + Returns the number and reason for removed contacts. Dates in the + YYYY-MM-DD format are used as keys in the response. + operationId: getCampaignStatisticsRemovals + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/RemovalsByDatesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsRemovals + /campaigns/statistics/balance: + get: + tags: + - Campaigns (Lists) + summary: Get balance statistics + description: >- + Returns the balance of subscriptions. Dates in the YYYY-MM-DD format are + used as keys in the response. + operationId: getCampaignStatisticsBalance + parameters: + - $ref: '#/components/parameters/CampaignStatisticsIdQuery' + - $ref: '#/components/parameters/CampaignStatisticsGroupByQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateFromQuery' + - $ref: '#/components/parameters/CampaignStatisticsDateToQuery' + responses: + '200': + $ref: '#/components/responses/BalanceByDatesStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsBalance + /campaigns/statistics/summary: + get: + tags: + - Campaigns (Lists) + summary: Get the statistics summary for selected campaigns + description: The results are indexed with the campaign ID. + operationId: getCampaignStatisticsSummary + parameters: + - name: query[campaignId] + in: query + required: false + schema: + $ref: '#/components/schemas/CampaignStatisticsIdQuery' + responses: + '200': + $ref: '#/components/responses/CampaignSummaryList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetCampaignStatisticsSummary + /webforms: + get: + tags: + - Legacy Forms + summary: Get Legacy Forms. + description: >- + Get the list of Legacy Forms. You can filter the resource using criteria + specified as `query[*]`. You can provide multiple criteria, to use AND + logic. You can sort the resource using parameters specified as + `sort[*]`. You can specify multiple fields to sort by. + operationId: getLegacyFormList + parameters: + - name: query[name] + in: query + description: Search Legacy Forms by name + required: false + schema: + type: string + - name: query[modifiedOn][from] + in: query + description: Search Legacy Forms modified from this date + required: false + schema: + type: string + format: date-time + - name: query[modifiedOn][to] + in: query + description: Search Legacy Forms modified to this date + required: false + schema: + type: string + format: date-time + - name: query[campaignId] + in: query + description: >- + Search Legacy Forms by campaignId. Accepts multiple IDs separated + with a comma + required: false + schema: + type: string + - name: sort[modifiedOn] + in: query + description: Sort Legacy Forms by modification date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/LegacyFormList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /gdpr-fields: + get: + tags: + - GDPR Fields + summary: Get the GDPR fields list + operationId: getGDPRFieldList + parameters: + - name: sort[name] + in: query + description: Sort fields by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort fields by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/GDPRFieldList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /workflow: + get: + tags: + - Workflows + summary: Get workflows + description: Get the list of workflows. + operationId: getWorkflowList + parameters: + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/WorkflowList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetWorkflows + /sms-automation: + get: + tags: + - SMS Automation Messages + summary: Get the list of automated SMS messages. + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getSMSAutomationList + parameters: + - name: query[name] + in: query + description: Search automated SMS messages by name + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: Search automated SMS messages by campaign (list) ID + required: false + schema: + type: string + - name: query[hasLinks] + in: query + description: Search for automated SMS messages containing links + required: false + schema: + type: boolean + - name: sort[status] + in: query + description: Sort by the status of the SMS message + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + description: Sort by the name of the automated SMS message + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[modifiedOn] + in: query + description: Sort by the date the SMS message was modified on + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[delivered] + in: query + description: Sort by the number of delivered SMS messages + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[sent] + in: query + description: Sort by the number of sent SMS messages + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[clicks] + in: query + description: Sort by the number of link clicks + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SmsAutomationList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /sms: + get: + tags: + - SMS Messages + summary: Get the list of SMS messages. + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getSMSList + parameters: + - name: query[type] + in: query + description: Search SMS messages by type + required: false + schema: + type: string + enum: + - sms + - draft + - name: query[name] + in: query + description: Search SMS messages by name + required: false + schema: + type: string + - name: query[sendingStatus] + in: query + description: Search SMS messages by status + required: false + schema: + type: string + enum: + - scheduled + - sending + - sent + - name: query[campaignId] + in: query + description: Search SMS messages by campaign (list) ID + required: false + schema: + type: string + - name: query[hasLinks] + in: query + description: Search for SMS messages with links + required: false + schema: + type: boolean + - name: sort[sendingStatus] + in: query + description: Sort by sending status + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[sendOn] + in: query + description: Sort by sending date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[modifiedOn] + in: query + description: Sort by modification date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[delivered] + in: query + description: Sort by number of delivered messages + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[sent] + in: query + description: Sort by number of sent messages + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[clicks] + in: query + description: Sort by number of link clicks + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/SmsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-labels: + - content: GetResponse MAX + class: primary + - content: Add-on required + class: warning + /autoresponders: + get: + tags: + - Autoresponders + summary: Get the list of autoresponders. + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getAutoresponderList + parameters: + - name: query[subject] + in: query + description: Search autoresponder by subject + required: false + schema: + type: string + - name: query[name] + in: query + description: Search autoresponder by name + required: false + schema: + type: string + - name: query[status] + in: query + description: Search autoresponder by status + required: false + schema: + type: string + enum: + - enabled + - disabled + - name: query[createdOn][from] + in: query + description: Search autoresponder created from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Search autoresponder created to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[campaignId] + in: query + description: Search autoresponder by campaign ID + required: false + schema: + type: string + - name: query[type] + in: query + description: Search autoresponder by type + required: false + schema: + type: string + enum: + - timebase + - actionbase + - name: query[triggerType] + in: query + description: Search autoresponder by triggerType + required: false + schema: + type: string + enum: + - onday + - name: sort[name] + in: query + description: Sort by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[subject] + in: query + description: Sort by subject + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[dayOfCycle] + in: query + description: Sort by cycle day + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[delivered] + in: query + description: Sort by delivered + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[openRate] + in: query + description: Sort by open rate + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[clickRate] + in: query + description: Sort by click rate + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdOn] + in: query + description: Sort by date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/AutoresponderList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + post: + tags: + - Autoresponders + summary: Create autoresponder + description: > + > + + **The action-based autoresponder feature has been migrated over to + marketing automation. Your existing autoresponders are + + now converted into workflows. You can no longer create and update + action-based autoresponders using our API.** + + + This request allows you to create an autoresponder. Remember to select + the proper `sendSettings` - depending on `type` you need to fill + corresponding setting (eg. if you selected type `delay`, then you MUST + fill `delayInHours` field). + operationId: createAutoresponder + requestBody: + $ref: '#/components/requestBodies/NewAutoresponder' + responses: + '201': + $ref: '#/components/responses/AutoresponderDetails' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 409 + code: 1008 + codeDescription: >- + There is another resource with the same value of unique + property + message: Property value is already taken + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1008 + context: [] + uuid: b89a0d53-67f6-4269-b207-223b42b6bfbd + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + /autoresponders/statistics: + get: + tags: + - Autoresponders + summary: The statistics for all autoresponders + description: >- + > + + This returns the statistics summary for selected autoresponders. You can + select them by specifying the autoresponder or campaign IDs. + + As in all statistics, you can change the date and time range (hourly + daily monthly or total). Keep in mind + + that all statistics date ranges are given in standard UTC period type + objects. ([See ISO 8601 + standard](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)) + + + (https://app.getresponse.com/statistics.html?t=followup#total). + You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by. + operationId: getAutoresponderStatisticsCollection + parameters: + - name: query[groupBy] + in: query + description: Group results by time interval + required: false + schema: + type: string + enum: + - total + - hour + - day + - month + - name: query[autoreponderId] + in: query + description: The list of autoresponder resource IDs (string separated with '') + required: false + schema: + type: string + - name: query[campaignId] + in: query + description: The list of campaign resource IDs (string separated with '') + required: false + schema: + type: string + - name: query[createdOn][from] + in: query + description: Count data from this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - name: query[createdOn][to] + in: query + description: Count data to this date + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/MessageStatisticsList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all + x-operation-class-name: GetAutorespondersStatistics + /websites: + get: + tags: + - Websites + summary: Get the list of websites + description: >- + You can filter the resource using criteria specified as `query[*]`. You + can provide multiple criteria, to use AND logic. You can sort the + resource using parameters specified as `sort[*]`. You can specify + multiple fields to sort by. + operationId: getWebsitesList + parameters: + - name: query[name] + in: query + description: Search websites by name + required: false + schema: + type: string + - name: query[status] + in: query + description: Search websites by status + required: false + schema: + type: string + enum: + - published + - unpublished + - name: stats[from] + in: query + description: Show statistics for websites from this date + required: false + schema: + type: string + format: date-time + - name: stats[to] + in: query + description: Show statistics for websites to this date + required: false + schema: + type: string + format: date-time + - name: sort[name] + in: query + description: Sort websites by name + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[createdAt] + in: query + description: Sort websites by creation date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[updatedAt] + in: query + description: Sort websites by modification date + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[pageViews] + in: query + description: Sort websites by page views + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[visits] + in: query + description: Sort by number of site visits + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - name: sort[uniqueVisitors] + in: query + description: Sort by number of unique visitors + required: false + schema: + $ref: '#/components/schemas/SortOrderEnum' + - $ref: '#/components/parameters/Fields' + - $ref: '#/components/parameters/PerPage' + - $ref: '#/components/parameters/Page' + responses: + '200': + $ref: '#/components/responses/WebsitesList' + '400': + description: Request validation error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 400 + code: 1000 + codeDescription: >- + General error of validation process, more details should + be in context section + message: Validation error, see context section for more information + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1000 + context: + validationType: searchFilter[query] + fieldName: name + originalName: lorem-ipsum + errorDescription: Not allowed search field + uuid: 77dabfd1-1fa7-4f9f-8d3f-487b4403e3aa + '401': + description: Authentication error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 401 + code: 1014 + codeDescription: Problem during authentication process, check headers! + message: >- + Unable to authenticate request. Check credentials or + authentication method details + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1014 + context: + authenticationType: auth_token + uuid: 62417847-4f12-4c25-9b3a-0b619a187efe + '429': + description: The throttling limit has been reached + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + example: + value: + httpStatus: 429 + code: 1015 + codeDescription: >- + Too many request to API, quota reached, please wait till + next quota window + message: >- + You have reached your requests limit for this time window, + please wait... + moreInfo: https://apidocs.getresponse.com/en/v3/errors/1015 + context: + currentLimit: 30000 + timeToReset: 100 seconds + uuid: 510c6726-7f65-46b7-a798-ca403133924f + security: + - api-key: [] + - oauth2: + - all +components: + schemas: + CreateAndUpdate: + properties: + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + updatedOn: + description: The date of the last update + type: string + format: date-time + readOnly: true + type: object + Shop: + properties: + shopId: + description: The shop ID + type: string + readOnly: true + example: pf3 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3 + name: + description: The shop name + type: string + maxLength: 124 + minLength: 4 + example: Monster market + locale: + description: The language locale (ISO 639-1) + type: string + example: PL + currency: + description: The currency code (ISO 4217) + type: string + example: PLN + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + NewShop: + required: + - name + - locale + - currency + type: object + allOf: + - $ref: '#/components/schemas/Shop' + BaseCategory: + properties: + categoryId: + description: The category ID + type: string + readOnly: true + example: atQ + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/categories/atQ + name: + description: The name of the category + type: string + maxLength: 64 + minLength: 2 + example: Headwear + parentId: + description: The parent category ID + type: string + maxLength: 64 + minLength: 2 + example: amh + isDefault: + description: This is a default category + type: boolean + example: true + url: + description: The external URL to the category + type: string + format: uri + maxLength: 2048 + example: https://somedomain.com/category/446 + externalId: + description: >- + The external ID is the identifying string or number of the category + given by another software + type: string + maxLength: 255 + example: ext3343 + type: object + Category: + type: object + allOf: + - $ref: '#/components/schemas/BaseCategory' + - $ref: '#/components/schemas/CreateAndUpdate' + NewCategory: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/Category' + UpdateCategory: + type: object + allOf: + - $ref: '#/components/schemas/Category' + UpdateShop: + type: object + allOf: + - $ref: '#/components/schemas/Shop' + ProductCategory: + type: object + allOf: + - $ref: '#/components/schemas/BaseCategory' + - $ref: '#/components/schemas/CreateAndUpdate' + NewProductCategory: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseCategory' + BaseMetaField: + properties: + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/meta-fields/NoF + metaFieldId: + description: The meta field ID + type: string + readOnly: true + example: NoF + name: + description: The meta field name + type: string + maxLength: 63 + minLength: 3 + example: Shoe size + value: + description: The meta field value + type: string + maxLength: 65000 + minLength: 0 + example: '11' + valueType: + description: The value type enumerable + type: string + enum: + - string + - integer + example: integer + description: + description: The meta field description + type: string + maxLength: 255 + minLength: 0 + example: Description of this meta field + type: object + MetaField: + type: object + allOf: + - $ref: '#/components/schemas/BaseMetaField' + - $ref: '#/components/schemas/CreateAndUpdate' + NewMetaField: + required: + - name + - value + - valueType + type: object + allOf: + - $ref: '#/components/schemas/BaseMetaField' + Product: + properties: + productId: + description: The product ID + type: string + readOnly: true + example: 9I + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/products/9I + name: + description: The product name + type: string + maxLength: 255 + minLength: 2 + example: Monster Cap + type: + description: The product type + type: string + maxLength: 64 + minLength: 2 + example: Headwear + url: + description: The external URL for the product + type: string + format: uri + maxLength: 2048 + example: https://somedomain.com/products/456 + vendor: + description: The product vendor + type: string + maxLength: 64 + minLength: 2 + example: GetResponse + externalId: + description: >- + The external ID is the identifying string or number of the product + given by another software + type: string + maxLength: 255 + example: '123456' + categories: + type: array + items: + $ref: '#/components/schemas/NewProductCategory' + variants: + type: array + items: + $ref: '#/components/schemas/NewProductVariant' + metaFields: + type: array + items: + $ref: '#/components/schemas/NewMetaField' + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + NewProduct: + required: + - name + - variants + type: object + allOf: + - $ref: '#/components/schemas/Product' + UpdateProduct: + type: object + allOf: + - $ref: '#/components/schemas/Product' + UpsertProductCategory: + description: >- + This method makes it possible to assign product categories, and to set a + default product category. It doesn't remove or unassign product + categories. + required: + - categories + properties: + categories: + type: array + items: + $ref: '#/components/schemas/UpsertSingleProductCategory' + type: object + UpsertSingleProductCategory: + required: + - categoryId + properties: + categoryId: + description: The category ID + type: string + example: atQ + isDefault: + description: This is a default category + type: boolean + example: true + type: object + UpsertMetaField: + description: This method assigns metafields. It doesn't unassign or delete them. + required: + - metaFields + properties: + metaFields: + type: array + items: + $ref: '#/components/schemas/UpsertSingleMetaField' + type: object + UpsertSingleMetaField: + required: + - metaFieldId + properties: + metaFieldId: + description: MetaField ID + type: string + example: NoF + type: object + UpdateMetaField: + type: object + allOf: + - $ref: '#/components/schemas/MetaField' + BaseProductVariant: + properties: + variantId: + description: The product ID + type: string + readOnly: true + example: VTB + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/products/9I/variants/VTB + name: + description: The product name + type: string + maxLength: 255 + minLength: 1 + example: Red Monster Cap + url: + description: The external URL to the product variant + type: string + format: uri + maxLength: 2048 + example: https://somedomain.com/products-variants/986 + sku: + description: >- + The stock-keeping unit of a variant. Must be unique within the + product + type: string + maxLength: 255 + minLength: 2 + example: SKU-1254-56-457-5689 + price: + description: The price + type: number + format: double + example: 20 + priceTax: + description: The price including tax + type: number + format: double + example: 27.5 + previousPrice: + description: The price before the change + type: number + format: double + example: 25 + nullable: true + previousPriceTax: + description: The price before the change including tax + type: number + format: double + example: 33.6 + nullable: true + quantity: + description: The quantity of variant items + type: integer + format: int64 + default: 1 + position: + description: The position of a variant + type: integer + format: int64 + example: 1 + barcode: + description: The barcode of a variant + type: string + maxLength: 255 + minLength: 2 + example: '12455687' + externalId: + description: >- + The external ID is the identifying string or number of the variant + given by another software + type: string + maxLength: 255 + example: ext1456 + description: + description: The description of a variant + type: string + maxLength: 1000 + minLength: 2 + example: Red Cap with GetResponse Monster print + images: + type: array + items: + $ref: '#/components/schemas/NewProductVariantImage' + metaFields: + type: array + items: + $ref: '#/components/schemas/NewMetaField' + taxes: + type: array + items: + $ref: '#/components/schemas/NewTax' + type: object + ProductVariant: + type: object + allOf: + - $ref: '#/components/schemas/BaseProductVariant' + - $ref: '#/components/schemas/CreateAndUpdate' + NewProductVariant: + required: + - name + - price + - priceTax + - sku + type: object + allOf: + - $ref: '#/components/schemas/BaseProductVariant' + UpdateProductVariant: + type: object + allOf: + - $ref: '#/components/schemas/ProductVariant' + NewProductVariantImage: + required: + - src + - position + properties: + imageId: + description: The image ID + type: string + readOnly: true + example: hY + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/images/hY + src: + description: The source URL of an image + type: string + format: uri + example: http://somedomain.com/images/src/img58db7ec64bab9.png + position: + description: The position of an image + type: integer + format: int32 + example: '1' + type: object + BaseTax: + properties: + taxId: + description: The tax ID + type: string + readOnly: true + example: Sk + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/taxes/Sk + name: + description: The tax name + type: string + maxLength: 255 + minLength: 2 + example: VAT + rate: + description: The rate value + type: number + format: double + maximum: 99.9 + minimum: 0 + example: 23 + type: object + Tax: + type: object + allOf: + - $ref: '#/components/schemas/BaseTax' + - $ref: '#/components/schemas/CreateAndUpdate' + NewTax: + required: + - name + - rate + type: object + allOf: + - $ref: '#/components/schemas/BaseTax' + UpdateTax: + type: object + allOf: + - $ref: '#/components/schemas/BaseTax' + Address: + properties: + addressId: + type: string + readOnly: true + example: k9 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/addresses/k9 + countryCode: + description: The country code (ISO 3166-1 alpha-3) + type: string + maxLength: 3 + minLength: 3 + example: POL + countryName: + description: The country name, based on `countryCode` + type: string + readOnly: true + example: Poland + name: + type: string + maxLength: 128 + minLength: 3 + example: some_shipping_address + firstName: + type: string + maxLength: 64 + minLength: 0 + example: John + lastName: + type: string + maxLength: 64 + minLength: 0 + example: Doe + address1: + description: Address line 1 + type: string + maxLength: 255 + minLength: 0 + example: Arkonska 6 + address2: + description: Address line 2 + type: string + maxLength: 255 + minLength: 0 + example: '' + city: + type: string + maxLength: 128 + minLength: 0 + example: Gdansk + zip: + description: The ZIP/postal code, free text + type: string + maxLength: 64 + minLength: 0 + example: 80-387 + province: + type: string + maxLength: 255 + minLength: 0 + example: pomorskie + provinceCode: + description: The province code, free text + type: string + maxLength: 64 + minLength: 0 + example: '' + phone: + description: The phone number, free text + type: string + maxLength: 255 + minLength: 0 + example: '1122334455' + company: + description: The company name, free text + type: string + maxLength: 128 + minLength: 0 + example: GetResponse + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + NewAddress: + required: + - name + - countryCode + type: object + allOf: + - $ref: '#/components/schemas/Address' + UpdateAddress: + type: object + allOf: + - $ref: '#/components/schemas/Address' + Order: + properties: + orderId: + description: The order ID + type: string + readOnly: true + example: fOh + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/orders/fOh + contactId: + description: >- + Create a contact by using `POST /v3/contacts`. Or, if the contact + already exists, using `GET /v3/contacts` + type: string + example: k8u + orderUrl: + description: The external URL for an order + type: string + format: uri + maxLength: 2048 + example: https://somedomain.com/orders/order446 + externalId: + description: >- + The external ID is the identifying string or number of the order + given by another software + type: string + maxLength: 255 + example: DH71239 + totalPrice: + description: The total price of an order + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 716 + totalPriceTax: + description: The total price tax of an order + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 358.67 + currency: + description: The order currency code (ISO 4217) + type: string + example: PLN + status: + description: The status value + type: string + maxLength: 64 + example: NEW + cartId: + description: Create a cart by using `POST /v3/shops/{shopId}/carts` + type: string + example: QBNgBR + description: + description: The order description + type: string + example: More information about order. + shippingPrice: + description: The shipping price for an order + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 23 + shippingAddress: + description: The shipping address for an order + allOf: + - $ref: '#/components/schemas/NewAddress' + billingStatus: + description: The billing status of an order + type: string + example: PENDING + billingAddress: + description: The billing address for an order + allOf: + - $ref: '#/components/schemas/NewAddress' + processedAt: + description: The exact time an order was made + type: string + format: date-time + metaFields: + type: array + items: + $ref: '#/components/schemas/NewMetaField' + type: object + OrderResponse: + properties: + selectedVariants: + type: array + items: + $ref: '#/components/schemas/OrderSelectedProductVariant' + type: object + allOf: + - $ref: '#/components/schemas/Order' + NewOrder: + required: + - contactId + - totalPrice + - currency + - selectedVariants + properties: + selectedVariants: + type: array + items: + $ref: '#/components/schemas/NewSelectedProductVariant' + type: object + allOf: + - $ref: '#/components/schemas/Order' + UpdateOrder: + type: object + allOf: + - $ref: '#/components/schemas/Order' + NewSelectedProductVariant: + required: + - variantId + - price + - quantity + properties: + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/aS/products/Rf/variants/aBc + variantId: + description: >- + The ID of a selected variant. You must first create a variant + using: + + + `POST` [Create + product](https://apireference.getresponse.com/#operation/createProduct) + + + `POST` [Create product + variant](https://apireference.getresponse.com/#operation/createProductVariant) + + or get ID from variants created already: + + `GET` [Get a list of product variants](https://apireference.getresponse.com/#operation/getProductVariantList) + type: string + example: p + price: + description: The product variant price + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 840 + priceTax: + description: The product variant price tax + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 428 + quantity: + description: The product variant quantity + type: integer + format: int32 + minimum: 1 + example: '2' + taxes: + type: array + items: + $ref: '#/components/schemas/NewTax' + type: object + OrderSelectedProductVariant: + required: + - variantId + - price + - quantity + properties: + categories: + type: array + items: + $ref: '#/components/schemas/BaseCategory' + type: object + allOf: + - $ref: '#/components/schemas/NewSelectedProductVariant' + NewCartSelectedProductVariant: + required: + - variantId + - quantity + - price + - priceTax + properties: + variantId: + description: >- + The ID of a selected variant. You must first create a variant + using: + + + `POST` [Create + product](https://apireference.getresponse.com/#operation/createProduct) + + + `POST` [Create product + variant](https://apireference.getresponse.com/#operation/createProductVariant) + + or get ID from variants created already: + + `GET` [Get a list of product variants](https://apireference.getresponse.com/#operation/getProductVariantList) + type: string + example: VTB + quantity: + description: The quantity + type: integer + format: int64 + minimum: 1 + example: 3 + price: + description: The price, tax excluded + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 57 + priceTax: + description: The price, tax included + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 68 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/products/9I/variants/VTB + type: object + Cart: + properties: + cartId: + description: The contact ID + type: string + readOnly: true + example: V + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3/carts/V + contactId: + description: >- + The ID of the contact that the cart belongs to. You must first + create the contact using POST /v3/contacts, or if it already exists, + using GET /v3/contacts + type: string + example: Vp + totalPrice: + description: The total cart price, tax excluded + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 1234.56 + totalTaxPrice: + description: The total cart price, tax included + type: number + format: double + maximum: 999999999999.99 + minimum: 0 + example: 1334.56 + currency: + description: The currency code (ISO 4217) + type: string + maxLength: 3 + minLength: 3 + example: USD + selectedVariants: + type: array + items: + $ref: '#/components/schemas/NewCartSelectedProductVariant' + externalId: + description: >- + The external ID is the identifying string or number of the cart, + given by another software + type: string + example: ext-1234 + cartUrl: + description: The external cart URL + type: string + format: url + example: http://example.com/cart/nQ + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + NewCart: + required: + - contactId + - totalPrice + - currency + - selectedVariants + type: object + allOf: + - $ref: '#/components/schemas/Cart' + UpdateCart: + type: object + allOf: + - $ref: '#/components/schemas/Cart' + Webinar: + properties: + webinarId: + type: string + readOnly: true + example: yK6d + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/webinars/yK6d + createdOn: + type: string + format: date-time + readOnly: true + startsOn: + type: string + format: date-time + webinarUrl: + description: The URL to the webinar room + type: string + format: uri + status: + type: string + enum: + - upcoming + - finished + - published + - unpublished + readOnly: true + type: + description: The webinar type + type: string + enum: + - all + - live + - on_demand + readOnly: true + campaigns: + type: array + items: + $ref: '#/components/schemas/CampaignReference' + newsletters: + description: The list of invitation messages + type: array + items: + $ref: '#/components/schemas/WebinarNewsletter' + statistics: + type: object + $ref: '#/components/schemas/WebinarStatistics' + type: object + WebinarStatistics: + required: + - registrants + - visitors + - attendees + properties: + registrants: + type: integer + format: int64 + example: 15 + visitors: + type: integer + format: int64 + example: 10 + attendees: + type: integer + format: int64 + example: 5 + type: object + WebinarNewsletter: + required: + - newsletterId + - href + properties: + newsletterId: + description: The ID of the webinar invitation message + type: string + example: NuE4 + href: + description: Direct hyperlink to a resource + type: string + example: https://api.getresponse.com/v3/newsletters/NuE4 + type: object + ContactCustomField: + properties: + customFieldId: + type: string + example: kL6Nh + values: + type: array + items: + type: string + example: 18-35 + type: object + ContactActivity: + properties: + activity: + description: The type of activity + type: string + enum: + - send + - open + - click + example: click + subject: + type: string + example: Shop offer update! + createdOn: + description: The activity date + type: string + format: date-time + previewUrl: + description: >- + This is only available for the `send` activity. It includes a link + to the message preview + type: string + format: uri + example: >- + https://www.grnewsletters.com/archive/campaign_name55f6b0ff01/Test-2135303.html + nullable: true + resource: + type: object + $ref: '#/components/schemas/ContactActivityResource' + clickTrack: + description: >- + This is only available for the `click` activity. It includes the + clicked link data + type: object + nullable: true + $ref: '#/components/schemas/ContactActivityClickTrack' + type: object + readOnly: true + ContactActivityClickTrack: + properties: + id: + description: The click tracking ID + type: string + example: 62WrE + name: + description: The name of the clicked link + type: string + example: Go to shop + url: + description: The URL of the clicked link + type: string + format: uri + example: https://my-shop.example.com/ + type: object + ContactActivityResource: + properties: + resourceId: + type: string + example: oY2n + nullable: true + resourceType: + type: string + enum: + - newsletters + - splittests + - autoresponders + - rss-newsletters + - sms + example: newsletters + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/newsletters/oY2n + type: object + ContactCustomFieldList: + type: array + items: + $ref: '#/components/schemas/ContactCustomField' + ContactListElement: + allOf: + - $ref: '#/components/schemas/Contact' + - properties: + note: + type: string + maxLength: 255 + minLength: 0 + nullable: true + ipAddress: + description: The contact's IP address. IPv4 and IPv6 formats are accepted. + example: 1.2.3.4 + oneOf: + - type: string + format: ipv4 + - type: string + format: ipv6 + type: object + ContactDetails: + type: object + allOf: + - $ref: '#/components/schemas/ContactListElement' + - properties: + geolocation: + type: object + readOnly: true + $ref: '#/components/schemas/ContactGeolocation' + tags: + description: The list of contact tags, limited to 500 tags. + type: array + items: + $ref: '#/components/schemas/ContactTag' + customFieldValues: + type: array + items: + $ref: '#/components/schemas/ContactCustomFieldValue' + type: object + ContactCustomFieldValue: + required: + - customFieldId + - name + - type + - value + - values + properties: + customFieldId: + description: Custom field ID + type: string + example: 4klkN + name: + type: string + example: age + value: + type: array + items: + type: string + example: 18-35 + values: + type: array + items: + type: string + example: 18-35 + type: + type: string + example: single_select + fieldType: + type: string + example: single_select + valueType: + type: string + example: string + type: object + ContactGeolocation: + properties: + latitude: + type: string + example: '54.35' + nullable: true + longitude: + type: string + example: '18.6667' + nullable: true + continentCode: + type: string + enum: + - OC + - AN + - SA + - NA + - AS + - EU + - AF + example: EU + nullable: true + countryCode: + description: The country code, compliant with ISO 3166-1 alpha-2 + type: string + example: PL + nullable: true + region: + type: string + example: '82' + nullable: true + postalCode: + type: string + example: 80-387 + nullable: true + dmaCode: + type: string + nullable: true + city: + type: string + example: Gdansk + nullable: true + type: object + BaseSearchContacts: + description: The short description of a saved search. + properties: + searchContactId: + description: The unique search-contact identifier + type: string + readOnly: true + example: pV3r + name: + description: The unique name of search-contact + type: string + example: custom test filter + createdOn: + description: The UTC date time format ISO 8601, e.g. 2018-04-10T10:02:57+0000 + type: string + format: date-time + readOnly: true + example: 2018-04-10T10:02:57+0000 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://app.getresponse.com/v3/search-contacts/pV3r + type: object + BaseSearchContactsDetails: + required: + - searchContactId + type: object + allOf: + - $ref: '#/components/schemas/BaseSearchContacts' + SearchContactsDetails: + description: Search contact details. + required: + - searchContactId + - name + - createdOn + - href + type: object + allOf: + - $ref: '#/components/schemas/SearchContactsConditionsDetails' + - $ref: '#/components/schemas/BaseSearchContacts' + SearchContactsConditionsDetails: + required: + - subscribersType + - sectionLogicOperator + - section + properties: + subscribersType: + description: Only one subscription status + type: array + items: + type: string + enum: + - subscribed + - undelivered + - removed + - unconfirmed + example: + - subscribed + sectionLogicOperator: + description: >- + Match 'any' (`or` value) or 'all' (`and` value) of the following + conditions + type: string + enum: + - or + - and + example: or + section: + type: array + items: + $ref: '#/components/schemas/SearchContactSection' + type: object + example: + subscribersType: + - subscribed + sectionLogicOperator: or + section: + - campaignIdsList: + - tamqY + logicOperator: or + subscriberCycle: + - receiving_autoresponder + - not_receiving_autoresponder + subscriptionDate: all_time + conditions: + - conditionType: crm + pipelineScope: PSVq + stageScope: all + NewSearchContacts: + description: New search contacts. + required: + - name + - subscribersType + - sectionLogicOperator + - section + type: object + allOf: + - $ref: '#/components/schemas/SearchContactsConditionsDetails' + - $ref: '#/components/schemas/BaseSearchContacts' + UpdateSearchContacts: + description: New search contacts. + required: + - name + - subscribersType + - sectionLogicOperator + - section + type: object + allOf: + - $ref: '#/components/schemas/SearchContactsConditionsDetails' + - $ref: '#/components/schemas/BaseSearchContacts' + SpecificDateEnum: + description: The specific date. + type: string + enum: + - today + - yesterday + - last_7_days + - last_30_days + - last_n_days + - this_week + - last_week + - this_month + - last_month + example: last_30_days + SpecificDateExtendedEnum: + description: The specific date. + type: string + example: last_30_days + oneOf: + - $ref: '#/components/schemas/SpecificDateEnum' + - description: The last 2 months specific date constant. + enum: + - last_2_months + RelationalNumericOperatorEnum: + description: The relational operators. + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_lt + MessageTypeOperator: + description: The type of message. + type: string + enum: + - autoresponder + - newsletter + - splittest + - automation + example: autoresponder + SearchedContactDetails: + properties: + contactId: + description: The contact identifier + type: string + example: jtLF5i + name: + description: The contact description + type: string + example: John Doe + nullable: true + email: + type: string + format: email + example: john.doe@example.com + origin: + type: string + enum: + - import + - email + - www + - panel + - leads + - sale + - api + - forward + - survey + - iphone + - copy + - landing_page + - webinar + example: landing_page + dayOfCycle: + type: string + format: integer + example: '153' + nullable: true + createdOn: + type: string + format: date-time + example: 2018-01-15T13:30:42+0000 + campaign: + type: object + example: + campaignId: tamqY + name: test_campaign + href: https://api.getresponse.com/v3/campaigns/tamqY + $ref: '#/components/schemas/CampaignReference' + score: + type: string + format: integer + example: '5' + nullable: true + reason: + type: string + enum: + - api + - automation + - blacklisted + - bounce + - cleaner + - complaint + - support + - unsubscribe + - user + example: support + nullable: true + deletedOn: + type: string + format: date-time + example: 2024-02-12T11:00:00+0000 + nullable: true + type: object + readOnly: true + SpecificDateType: + description: The date formatted as yyyy-mm-dd + type: string + format: date + example: '2018-04-01' + SpecificDateTimeType: + description: The date time string compliant with ISO 8601 + type: string + format: date + example: 2018-04-01T00:00:00+0000 + IntervalDateType: + description: >- + The date interval string compliant with ISO 8601, supported format: + / + type: string + example: 2018-04-01/2018-04-10 + ConditionStringOperator: + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - string_operator + example: string_operator + operator: + type: string + enum: + - is + - is_not + - contains + - not_contains + - starts + - ends + - not_starts + - not_ends + example: is_not + value: + type: string + example: new + type: object + example: + operatorType: string_operator + operator: starts + value: new + ConditionStringOperatorList: + description: Used with a custom field only. + required: + - operatorType + - operator + properties: + operatorType: + type: string + enum: + - string_operator_list + example: string_operator_list + operator: + type: string + enum: + - is + - is_not + - contains + - not_contains + - starts + - ends + - not_starts + - not_ends + - assigned + - not_assigned + example: is + value: + description: The value of the search + type: string + example: 18-29 + type: object + example: + operatorType: string_operator_list + operator: is + value: 18-29 + ConditionMessageOperator: + description: The operator allows searching by message type. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - message_operator + example: message_operator + operator: + $ref: '#/components/schemas/MessageTypeOperator' + value: + description: >- + The identifier of a selected resource: autoresponder, newsletter, + split test or automation message + type: string + example: SGNLr + type: object + example: + operatorType: message_operator + operator: autoresponder + value: SGNLr + CustomDateRange: + required: + - from + - to + properties: + from: + description: The UTC date format + type: string + format: date + example: '2018-04-01' + to: + description: The UTC date format + type: string + format: date + example: '2018-04-10' + type: object + SectionAllTimeSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionTodaySubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionYesterdaySubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionLast7DaysSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionLast30DaysSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionThisWeekSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionLastWeekSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionThisMonthSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionLastMonthSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionLast2MonthsSubscriptionDate: + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SectionCustomSubscriptionDate: + required: + - customDate + properties: + customDate: + type: object + $ref: '#/components/schemas/CustomDateRange' + type: object + allOf: + - $ref: '#/components/schemas/SearchContactSection' + SearchContactSection: + required: + - campaignIdsList + - logicOperator + - subscriberCycle + - subscriptionDate + properties: + campaignIdsList: + description: An array of campaign identifiers + type: array + items: + type: string + example: tamqY + example: + - tamqY + - tuKd3 + logicOperator: + type: string + enum: + - and + - or + subscriberCycle: + description: Defining whether or not a subscriber is in an autoresponder cycle + type: array + items: + type: string + enum: + - receiving_autoresponder + - not_receiving_autoresponder + example: + - receiving_autoresponder + - not_receiving_autoresponder + conditions: + description: One of the search contact conditions + type: array + items: + $ref: '#/components/schemas/ConditionType' + subscriptionDate: + description: Matches the matching period + type: string + enum: + - all_time + - today + - yesterday + - last_7_days + - last_30_days + - this_week + - last_week + - this_month + - last_month + - last_2_months + - custom + type: object + discriminator: + propertyName: subscriptionDate + mapping: + all_time: '#/components/schemas/SectionAllTimeSubscriptionDate' + today: '#/components/schemas/SectionTodaySubscriptionDate' + yesterday: '#/components/schemas/SectionYesterdaySubscriptionDate' + last_7_days: '#/components/schemas/SectionLast7DaysSubscriptionDate' + last_30_days: '#/components/schemas/SectionLast30DaysSubscriptionDate' + this_week: '#/components/schemas/SectionThisWeekSubscriptionDate' + last_week: '#/components/schemas/SectionLastWeekSubscriptionDate' + this_month: '#/components/schemas/SectionThisMonthSubscriptionDate' + last_month: '#/components/schemas/SectionLastMonthSubscriptionDate' + last_2_months: '#/components/schemas/SectionLast2MonthsSubscriptionDate' + custom: '#/components/schemas/SectionCustomSubscriptionDate' + ConditionType: + required: + - conditionType + properties: + conditionType: + type: string + enum: + - name + - email + - custom + - subscription_date + - subscription_method + - opened + - not_opened + - phase + - last_send_date + - last_click_date + - last_open_date + - webinar + - clicked + - not_clicked + - sent + - not_sent + - geo + - scoring + - engagement_score + - tag + - goal + - crm + - ecommerce_number_of_purchases + - ecommerce_total_spent + - ecommerce_product_purchased + - ecommerce_brand_purchased + - ecommerce_abandoned_cart + - sms_sent + - sms_delivered + - sms_link_clicked + - sms_link_not_clicked + - custom_event + type: object + discriminator: + propertyName: conditionType + mapping: + name: '#/components/schemas/NameCondition' + email: '#/components/schemas/EmailCondition' + custom: '#/components/schemas/CustomFieldCondition' + subscription_date: '#/components/schemas/SubscriptionDateCondition' + subscription_method: '#/components/schemas/SubscriptionMethodCondition' + opened: '#/components/schemas/OpenedCondition' + not_opened: '#/components/schemas/NotOpenedCondition' + phase: '#/components/schemas/AutoresponderDayCondition' + last_send_date: '#/components/schemas/LastSendDateCondition' + last_click_date: '#/components/schemas/LastClickDateCondition' + last_open_date: '#/components/schemas/LastOpenDateCondition' + webinar: '#/components/schemas/WebinarCondition' + clicked: '#/components/schemas/LinkClickedCondition' + not_clicked: '#/components/schemas/LinkNotClickedCondition' + sent: '#/components/schemas/MessageSentCondition' + not_sent: '#/components/schemas/MessageNotSentCondition' + geo: '#/components/schemas/GeolocationCondition' + scoring: '#/components/schemas/ScoringCondition' + engagement_score: '#/components/schemas/EngagementScoreCondition' + tag: '#/components/schemas/TagCondition' + goal: '#/components/schemas/GoalCondition' + crm: '#/components/schemas/CrmCondition' + ecommerce_number_of_purchases: '#/components/schemas/ECommerceNumberOfPurchasesCondition' + ecommerce_total_spent: '#/components/schemas/ECommerceTotalSpentCondition' + ecommerce_product_purchased: '#/components/schemas/ECommerceProductPurchasedCondition' + ecommerce_brand_purchased: '#/components/schemas/ECommerceBrandPurchasedCondition' + sms_sent: '#/components/schemas/SmsSentCondition' + sms_delivered: '#/components/schemas/SmsDeliveredCondition' + sms_link_clicked: '#/components/schemas/SmsLinkClickedCondition' + sms_link_not_clicked: '#/components/schemas/SmsLinkNotClickedCondition' + ecommerce_abandoned_cart: '#/components/schemas/ECommerceAbandonedCartCondition' + custom_event: '#/components/schemas/CustomEventCondition' + NameCondition: + type: object + example: + conditionType: name + operatorType: string_operator + operator: contains + value: John + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionStringOperator' + EmailCondition: + type: object + example: + conditionType: email + operatorType: string_operator + operator: contains + value: john + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionStringOperator' + CustomFieldCondition: + description: Search a contact by custom fields. + required: + - operator + - scope + - operatorType + properties: + operatorType: + description: >- + Depends on the type of custom field, read more in [custom field + condition documentation in segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual#get-by-custom-fields-search-contacts) + type: string + enum: + - string_operator_list + - string_operator + - numeric_operator + - date_operator + example: string_operator_list + operator: + description: >- + Depends on selected `"operatorType"`, read more in [custom field + condition documentation in segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual#get-by-custom-fields-search-contacts) + type: string + example: is + oneOf: + - $ref: '#/components/schemas/CustomFieldStringOperatorEnum' + - $ref: '#/components/schemas/CustomFieldNumericOperatorEnum' + - $ref: '#/components/schemas/CustomFieldDateOperatorEnum' + value: + description: >- + Depends on selected `"operator"` and `"operatorType"`, read more in + [custom field condition documentation in segments (search contacts) + reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual#get-by-custom-fields-search-contacts) + type: string + example: new + oneOf: + - $ref: '#/components/schemas/CustomFieldValueForStringOperatorTypes' + - $ref: '#/components/schemas/CustomFieldValueForNumericOperatorType' + - $ref: >- + #/components/schemas/CustomFieldValueForOperatorTypeDateAndOperatorSpecificDate + - $ref: >- + #/components/schemas/CustomFieldValueDateForOperatorTypeDateAndOperatorDateToOrDateFrom + - $ref: >- + #/components/schemas/CustomFieldValueDateTimeForOperatorTypeDateAndOperatorDateToOrDateFrom + - $ref: >- + #/components/schemas/CustomFieldValueForOperatorTypeDateAndOperatorCustom + scope: + description: >- + The identifier of the custom field, read more in [custom field + condition documentation in segments (search contacts) reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual#get-by-custom-fields-search-contacts) + type: string + numberOfDays: + description: >- + Required only when `"value":"last_n_days"`, read more in [custom + field condition documentation in segments (search contacts) + reference + manual](https://apidocs.getresponse.com/v3/case-study/segments-manual#get-by-custom-fields-search-contacts) + type: integer + example: 20 + includeCurrentPeriod: + description: >- + Flag determines if current day will be included into chosen range. + This flag can be used with `last_n_days`. + type: boolean + example: true + type: object + example: + conditionType: custom + scope: pa3N6 + operatorType: string_operator_list + operator: is + value: Female + allOf: + - $ref: '#/components/schemas/ConditionType' + CustomFieldStringOperatorEnum: + description: >- + Allowed operators for `"operatorType":"string_operator"` and + `"operatorType":"string_operator_list"` + type: string + enum: + - is + - is_not + - contains + - not_contains + - starts + - ends + - not_starts + - not_ends + - assigned + - not_assigned + example: is + CustomFieldNumericOperatorEnum: + description: Allowed operators for `"operatorType":"numeric_operator"` + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + - assigned' + - not_assigned + example: numeric_lt + CustomFieldDateOperatorEnum: + description: Allowed operators for `"operatorType":"date_operator"` + type: string + enum: + - date_to + - date_from + - custom + - specific_date + - assigned + - not_assigned + example: date_to + CustomFieldValueForStringOperatorTypes: + description: >- + Any string, allowed only for `"operatorType":"string_operator"` and + `"operatorType":"string_operator_list"` + type: string + example: Canada + CustomFieldValueForNumericOperatorType: + description: Any number, allowed only for `"operatorType":"numeric_operator"` + type: string + example: '1' + CustomFieldValueForOperatorTypeDateAndOperatorSpecificDate: + description: >- + Allowed values for `"operatorType":"date_operator"` with + `"operator":"specific_date"` + type: string + enum: + - today + - yesterday + - last_7_days + - last_30_days + - last_n_days + - this_week + - last_week + - this_month + - last_month + - last_2_months + example: today + CustomFieldValueDateForOperatorTypeDateAndOperatorDateToOrDateFrom: + description: >- + Date string formatted as yyyy-mm-dd, allowed only for + `"operatorType":"date_operator"` with `"operator":"date_to"` or + `"operator":"date_from"` + allOf: + - $ref: '#/components/schemas/SpecificDateType' + CustomFieldValueDateTimeForOperatorTypeDateAndOperatorDateToOrDateFrom: + description: >- + Date time string compliant with ISO 8601, allowed only for + `"operatorType":"date_operator"` with `"operator":"date_to"` or + `"operator":"date_from"` + allOf: + - $ref: '#/components/schemas/SpecificDateTimeType' + CustomFieldValueForOperatorTypeDateAndOperatorCustom: + description: >- + Date interval string compliant with ISO 8601, supported format: + /, allowed only for + `"operatorType":"date_operator"` with `"operator":"custom"` + allOf: + - $ref: '#/components/schemas/IntervalDateType' + SubscriptionDateCondition: + description: Use this to find a contact by subscription date, use. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - date_operator + example: date_operator + operator: + type: string + enum: + - date_to + - date_from + - specific_date + - custom + value: + type: string + example: 2018-04-01/2018-04-30 + oneOf: + - allOf: + - $ref: '#/components/schemas/SpecificDateType' + - allOf: + - $ref: '#/components/schemas/SpecificDateTimeType' + - allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + - allOf: + - $ref: '#/components/schemas/IntervalDateType' + type: object + example: + conditionType: subscription_date + operatorType: date_operator + operator: custom + value: 2018-04-01/2018-04-30 + allOf: + - $ref: '#/components/schemas/ConditionType' + SubscriptionMethodCondition: + description: The subscription method. + required: + - method + properties: + method: + type: string + enum: + - webform + - import + - landing_page + - api + - email + - panel + - mobile + - forward + - survey + - sales + - copy + - leads + - webinar + webformType: + description: >- + The property required for the webform subscription method. If it + equals webforms, webformsv2 or popups, additonal property value is + needed. + type: string + enum: + - all + - webforms + - webformsv2 + - popups + value: + description: >- + The field required for `import`, `landing_page` and `webinar`, + optional for the `webform` method + type: string + oneOf: + - description: >- + If the method value equals `webform`, then the value is equal to + the webform, webformv2 or popup identifiers. The field is + required for the webformType={webforms, webformsv2, popups}. + example: PSO39 + - description: >- + If the method value equals `import`, then the value is equal to + the import identifier, or all for ‘all’ imports. + example: all + - description: >- + If the method value equals `landing_page`, then the value is + equal to the landing page identifier, or ‘all’ for all landing + pages + example: all + - description: >- + If the method value equals `webinar`, then the value is equal to + the webinar identifier, or ‘all’ for all webinars + example: all + type: object + allOf: + - $ref: '#/components/schemas/ConditionType' + OpenedCondition: + description: Search contacts who did open a message. + type: object + example: + conditionType: opened + operatorType: message_operator + operator: autoresponder + value: 'SGNLr:' + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionMessageOperator' + NotOpenedCondition: + description: Search contacts who didn't open a message. + required: + - operatorType + - operator + - dateOperator + properties: + operatorType: + type: string + enum: + - complex_message_operator + example: complex_message_operator + operator: + description: Specifies the type of message to search for + example: newsletter + oneOf: + - description: For all available message types + type: string + enum: + - all + example: all + - $ref: '#/components/schemas/MessageTypeOperator' + scope: + description: >- + The message identifier. Required only for the operator different + from 'all'. + type: string + example: z4Zje + dateOperator: + description: >- + It allows you to set a date range. For some of them `value` will be + required. Examples can be found here: [API + Docs](https://apidocs.getresponse.com/v3/case-study/segments-manual#not-opened-action). + type: string + enum: + - date_from + - never + - today + - yesterday + - last_7_days + - last_30_days + - last_n_days + - this_week + - this_month + value: + description: >- + This field is required only for `date_from` and `last_n_days` date + operators. + oneOf: + - description: >- + The date string compliant with ISO 8601. The value field is + required for the dateOperator equal to `date_from`. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: Number of days. Required for `last_n_days` date operator. + type: integer + example: 10 + includeCurrentPeriod: + description: >- + Flag determines if current day will be included into chosen range. + This flag can be used with `last_7_days`, `last_30_days`, + `last_n_days`. + type: boolean + example: true + type: object + example: + conditionType: not_opened + operatorType: complex_message_operator + scope: z4Zje + operator: autoresponder + dateOperator: never + allOf: + - $ref: '#/components/schemas/ConditionType' + AutoresponderDayCondition: + description: To find the autoresponder cycle day of a contact. + required: + - operatorType + - operator + properties: + operatorType: + type: string + enum: + - numeric_operator + operator: + type: string + oneOf: + - $ref: '#/components/schemas/RelationalNumericOperatorEnum' + - enum: + - assigned + - not_assigned + example: assigned + value: + description: >- + The autoresponder cycle day value. The field is prohibited for the + operators assigned and not_assigned. + type: integer + format: int32 + example: 6 + type: object + example: + conditionType: phase + operatorType: numeric_operator + operator: numeric_eq + value: 6 + allOf: + - $ref: '#/components/schemas/ConditionType' + LastSendDateCondition: + description: Search the last time when an email message was sent to a contact. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - date_operator + operator: + type: string + enum: + - date_to + - date_from + - specific_date + - custom + value: + type: string + example: last_7_days + oneOf: + - description: >- + For `date_to` or `date_from` operators. Date string is compliant + with ISO 8601. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: >- + For the operator=custom, it's the time interval compliant with + ISO 8601 + allOf: + - $ref: '#/components/schemas/IntervalDateType' + - description: For a specific_date operator + allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + type: object + example: + conditionType: last_send_date + operatorType: date_operator + operator: specific_date + value: last_7_days + allOf: + - $ref: '#/components/schemas/ConditionType' + LastClickDateCondition: + description: This is used to find the last time when a contact clicked a message. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - date_operator + example: date_operator + operator: + type: string + enum: + - date_to + - date_from + - specific_date + - custom + example: specific_date + value: + type: string + example: last_7_days + oneOf: + - description: >- + For `date_to` or `date_from` operators. Date string is compliant + with ISO 8601. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: >- + For the operator=custom, it's the time interval compliant with + ISO 8601 + allOf: + - $ref: '#/components/schemas/IntervalDateType' + - description: For the specific_date operator + allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + type: object + example: + conditionType: last_click_date + operatorType: date_operator + operator: specific_date + value: last_7_days + allOf: + - $ref: '#/components/schemas/ConditionType' + LastOpenDateCondition: + description: Search the last time when a contact opened a message. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - date_operator + example: date_operator + operator: + type: string + enum: + - date_to + - date_from + - specific_date + - custom + example: specific_date + value: + type: string + example: last_7_days + oneOf: + - description: >- + For `date_to` or `date_from` operators. Date string is compliant + with ISO 8601. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: >- + For the operator=custom, it's the time interval compliant with + ISO 8601 + allOf: + - $ref: '#/components/schemas/IntervalDateType' + - description: For the specific_date operator + allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + type: object + example: + conditionType: last_open_date + operatorType: date_operator + operator: specific_date + value: last_7_days + allOf: + - $ref: '#/components/schemas/ConditionType' + WebinarCondition: + description: >- + Search contacts that have participated/not participated in a specific + webinar as a host/listener/presenter/registrant/any user. + required: + - scope + - webinarCondition + - contactType + properties: + scope: + description: The identifier of a webinar + type: string + example: MNAR + webinarCondition: + type: string + enum: + - participated + - not_participated + example: participated + contactType: + type: string + enum: + - host + - listener + - presenter + - registrant + - all + example: presenter + type: object + example: + conditionType: webinar + scope: MNAR + webinarCondition: participated + contactType: presenter + allOf: + - $ref: '#/components/schemas/ConditionType' + LinkClickedCondition: + description: Search contacts that clicked on a link. + required: + - operatorType + - operator + - scope + - clickTrackId + properties: + operatorType: + type: string + enum: + - message_operator + example: message_operator + operator: + $ref: '#/components/schemas/MessageTypeOperator' + scope: + description: The message identifier + type: string + example: SGNLr + clickTrackId: + oneOf: + - type: string + enum: + - all + example: all + - description: The identifier of the clickTrackId + type: string + example: SGNLr + type: object + example: + conditionType: clicked + operatorType: message_operator + operator: autoresponder + scope: SGNLr + clickTrackId: all + allOf: + - $ref: '#/components/schemas/ConditionType' + LinkNotClickedCondition: + description: Search contacts that didn't click a link. + required: + - operatorType + - operator + - dateOperator + properties: + operatorType: + type: string + enum: + - complex_message_operator + example: complex_message_operator + operator: + example: newsletter + oneOf: + - description: For all available message types + type: string + enum: + - all + example: all + - $ref: '#/components/schemas/MessageTypeOperator' + dateOperator: + description: >- + It allows you to set a date range. For some of them `value` will be + required. Examples can be found here: [API + Docs](https://apidocs.getresponse.com/v3/case-study/segments-manual#not-opened-action). + enum: + - date_from + - never + - today + - yesterday + - last_7_days + - last_30_days + - last_n_days + - this_week + - this_month + example: today + value: + description: >- + This field is required only for `date_from` and `last_n_days` date + operators. + oneOf: + - description: >- + The date string compliant with ISO 8601. The value field is + required for the dateOperator equal to `date_from`. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: Number of days. Required for `last_n_days` date operator. + type: integer + example: 10 + includeCurrentPeriod: + description: >- + Flag determines if current day will be included into chosen range. + This flag can be used with `last_7_days`, `last_30_days`, + `last_n_days`. + type: boolean + example: true + scope: + description: >- + The message identifier. This field is prohibited for the 'all' + operator. + type: string + example: zhgnQ + clickTrackId: + description: The click track identifier + type: string + example: PPxiOW + oneOf: + - description: For all possible links in a message + enum: + - all + example: all + - description: For a specified click track ID + example: PPxiOW + type: object + example: + conditionType: not_clicked + operatorType: complex_message_operator + operator: newsletter + dateOperator: today + scope: zhgnQ + clickTrackId: all + allOf: + - $ref: '#/components/schemas/ConditionType' + MessageSentCondition: + description: Search contacts who received a certain message. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - message_operator + example: message_operator + operator: + $ref: '#/components/schemas/MessageTypeOperator' + value: + description: The message identifier + type: string + example: zSFIB + type: object + example: + conditionType: sent + operatorType: message_operator + operator: autoresponder + value: zSFIB + allOf: + - $ref: '#/components/schemas/ConditionType' + MessageNotSentCondition: + description: Search contacts who didn't receive a certain message. + required: + - operatorType + - operator + - value + properties: + operatorType: + type: string + enum: + - message_operator + example: message_operator + operator: + $ref: '#/components/schemas/MessageTypeOperator' + value: + description: The message identifier + type: string + example: z4Zje + type: object + example: + conditionType: not_sent + operatorType: message_operator + operator: autoresponder + value: z4Zje + allOf: + - $ref: '#/components/schemas/ConditionType' + ECommerceBrandPurchasedCondition: + description: Search contacts by brand purchased. + required: + - scope + - operatorType + - operator + - value + properties: + scope: + description: The shop identifier + type: string + example: ZTo + operatorType: + type: string + enum: + - equal_operator + example: equal_operator + operator: + type: string + enum: + - is + - not_is + example: is + value: + type: string + example: GetResponse + type: object + example: + conditionType: ecommerce_brand_purchased + scope: ZTo + operatorType: equal_operator + operator: is + value: GetResponse + allOf: + - $ref: '#/components/schemas/ConditionType' + ECommerceProductPurchasedCondition: + description: Search the product purchased. + required: + - shopScope + - categoryScope + - operatorType + - operator + - productScope + - dateOperator + properties: + shopScope: + description: Limit the searched shops + type: string + oneOf: + - description: For all available shops + enum: + - all + example: all + - description: The shop identifier + example: ZTo + categoryScope: + description: The product category + type: string + oneOf: + - description: For all available categories + enum: + - all + example: all + - description: The category identifier + example: PZ3 + operatorType: + type: string + enum: + - equal_operator + example: equal_operator + operator: + type: string + enum: + - is + - is_not + example: is + productScope: + type: string + oneOf: + - description: For all available products + enum: + - all + example: all + - description: For a specified product + example: oZt + dateOperator: + description: >- + Set a date range. For the date_from and date_to, custom field value + is required. + type: string + oneOf: + - description: >- + The field value is prohibited. The date string is compliant with + ISO 8601. + allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + - description: The field value is prohibited + enum: + - all_time + example: all_time + - description: The field value is required + enum: + - date_to + - date_from + - custom + value: + description: >- + This field stores the date or time interval for the date operators + date_to, date_from, or custom + type: string + example: '2018-04-01' + oneOf: + - description: >- + For the dateOperator date_to and date_from, it's the time + compliant with ISO 8601 + $ref: '#/components/schemas/SpecificDateType' + - description: >- + For the dateOperator=custom, it's the time interval compliant + with ISO 8601 + $ref: '#/components/schemas/IntervalDateType' + type: object + example: + conditionType: ecommerce_product_purchased + shopScope: all + categoryScope: all + operatorType: equal_operator + operator: is + productScope: all + dateOperator: date_from + value: '2018-04-01' + allOf: + - $ref: '#/components/schemas/ConditionType' + ECommerceTotalSpentCondition: + description: Search contacts by total spent. + required: + - operatorType + - operator + - scope + - value + - currency + properties: + operatorType: + type: string + enum: + - numeric_operator + example: numeric_operator + operator: + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_eq + scope: + description: The condition limiting the searched shop + type: string + example: Zto + oneOf: + - description: For all available shops + enum: + - all + example: all + - description: The shop identifier + example: ZTo + value: + type: number + format: double + example: '7.00' + currency: + description: The currency code according to ISO 4217, i.e. USD, GBP, PLN + type: string + example: USD + type: object + example: + conditionType: ecommerce_total_spent + scope: all + operatorType: numeric_operator + operator: numeric_eq + value: 7 + currency: USD + allOf: + - $ref: '#/components/schemas/ConditionType' + ECommerceNumberOfPurchasesCondition: + description: Search contacts by the number of purchases. + required: + - operatorType + - operator + - scope + - value + properties: + operatorType: + type: string + enum: + - numeric_operator + example: numeric_operator + operator: + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_eq + scope: + description: The condition limiting the searched shop + type: string + example: Zto + oneOf: + - description: For all available shops + enum: + - all + example: all + - description: The shop identifier + example: ZTo + value: + type: integer + format: int32 + example: 7 + type: object + example: + conditionType: ecommerce_number_of_purchases + scope: all + operatorType: numeric_operator + operator: numeric_eq + value: 7 + allOf: + - $ref: '#/components/schemas/ConditionType' + TagCondition: + description: Search contacts by tag. + required: + - operatorType + - operator + - value + properties: + operatorType: + description: The operator for the existence of a property + type: string + enum: + - exists + example: exists + operator: + description: >- + This operator verifies whether the property you are looking for + exists or not + type: string + enum: + - exists + - not_exists + example: exists + value: + description: The tag identifier + type: string + example: BB + type: object + example: + conditionType: tag + value: BB + operatorType: exists + operator: exists + allOf: + - $ref: '#/components/schemas/ConditionType' + ECommerceAbandonedCartCondition: + description: Search contacts by abandoned cart. + required: + - shopScope + - dateOperator + properties: + shopScope: + description: Limit the searched shops + type: string + oneOf: + - description: For all available shops + enum: + - all + example: all + - description: The shop identifier + example: ZTo + dateOperator: + description: >- + Set a date range. For the date_from and last_n_days, custom field + value is required. Examples can be found here: [API + Docs](https://apidocs.getresponse.com/v3/case-study/segments-manual/#ecommerce-abandoned-cart-condition-type). + type: string + enum: + - date_from + - anytime + - never + - today + - yesterday + - last_n_days + - this_week + - this_month + value: + description: >- + This field is required only for `date_from` and `last_n_days` date + operators. + oneOf: + - description: >- + The date string compliant with ISO 8601. The value field is + required for the dateOperator equal to `date_from`. + allOf: + - $ref: '#/components/schemas/SpecificDateType' + - description: Number of days. Required for `last_n_days` date operator. + type: integer + example: 10 + includeCurrentPeriod: + description: >- + Flag determines if current day will be included into chosen range. + This flag can be used with `last_n_days`. + type: boolean + example: true + type: object + example: + conditionType: ecommerce_abandoned_cart + shopScope: ZTo + dateOperator: date_from + value: '2018-04-01' + allOf: + - $ref: '#/components/schemas/ConditionType' + SmsSentCondition: + description: Find contacts who were sent an SMS + required: + - smsId + properties: + smsId: + description: The SMS message ID + type: string + example: ZTo + type: object + example: + conditionType: sms_sent + smsId: ZTo + allOf: + - $ref: '#/components/schemas/ConditionType' + SmsDeliveredCondition: + description: Find contacts who received an SMS + required: + - smsId + properties: + smsId: + description: The SMS message ID + type: string + example: ZTo + type: object + example: + conditionType: sms_delivered + smsId: ZTo + allOf: + - $ref: '#/components/schemas/ConditionType' + SmsLinkClickedCondition: + description: Find contacts who clicked a link from an SMS + required: + - smsId + - clickTrackId + properties: + smsId: + description: The SMS message ID + type: string + example: ZTo + clickTrackId: + description: The click track ID + type: string + example: ABc + type: object + example: + conditionType: sms_link_clicked + smsId: ZTo + clickTrackId: ABc + allOf: + - $ref: '#/components/schemas/ConditionType' + SmsLinkNotClickedCondition: + description: Find contacts who didn't click a link from an SMS + required: + - smsId + - clickTrackId + properties: + smsId: + description: The SMS message ID + type: string + example: ZTo + clickTrackId: + description: The click track ID + type: string + example: ABc + type: object + example: + conditionType: sms_link_not_clicked + smsId: ZTo + clickTrackId: ABc + allOf: + - $ref: '#/components/schemas/ConditionType' + ScoringCondition: + description: Search contacts by scoring. + required: + - operatorType + properties: + operatorType: + type: string + enum: + - numeric_operator + - not_exists + example: numeric_operator + operator: + description: >- + The relational operator. Required for the + operatorType=numeric_operator. + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_lt + value: + description: >- + This field is required for the relational operator, and prohibited + for the not_exists operator type + type: integer + format: int32 + example: 5 + type: object + example: + conditionType: score + operatorType: numeric_operator + operator: numeric_lt + value: 5 + allOf: + - $ref: '#/components/schemas/ConditionType' + EngagementScoreCondition: + description: Search contacts by their engagement score + required: + - operator + - value + properties: + operatorType: + type: string + enum: + - numeric_operator + example: numeric_operator + operator: + description: The operator used in engagement score comparison + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + example: numeric_lt + value: + description: The condition value + type: integer + format: int32 + example: 5 + type: object + example: + conditionType: engagement_score + operatorType: numeric_operator + operator: numeric_lt + value: 5 + allOf: + - $ref: '#/components/schemas/ConditionType' + GeolocationCondition: + description: Search contacts by geolocation. + required: + - operatorType + - operator + - value + - scope + properties: + scope: + description: Specify the search parameters + type: string + enum: + - country + - country_code + - region + - city + - longitude + - latitude + - postal_code + - dma_code + example: city + type: object + example: + conditionType: geo + operatorType: string_operator + operator: starts + value: New + scope: city + allOf: + - $ref: '#/components/schemas/ConditionType' + - $ref: '#/components/schemas/ConditionStringOperator' + CrmCondition: + description: This makes it possible to search contacts by CRM conditions. + required: + - pipelineScope + - stageScope + properties: + pipelineScope: + description: The pipeline identifier + type: string + example: PSVq + stageScope: + description: '' + type: string + example: ZAHB + oneOf: + - description: For all available stages + enum: + - all + example: all + - description: The stage identifier + example: ZAHB + type: object + example: + conditionType: crm + pipelineScope: PSVq + stageScope: ZAHB + allOf: + - $ref: '#/components/schemas/ConditionType' + GoalCondition: + description: Search contacts by a defined goal. + required: + - operatorType + - operator + - scope + properties: + operatorType: + type: string + enum: + - numeric_operator + example: numeric_operator + operator: + description: >- + The relational and existence operator. For the relational operator, + the value field is required. + type: string + enum: + - numeric_lt + - numeric_gt + - numeric_eq + - numeric_not_eq + - numeric_lt_eq + - numeric_gt_eq + - assigned + - not_assigned + example: numeric_lt + value: + description: >- + The value to be compared for the relational operator. For the + assigned, the not_assigned operator field is prohibited. + type: integer + format: int32 + example: 5 + scope: + description: The goal identifier + type: string + example: p22 + type: object + example: + conditionType: goal + operatorType: numeric_operator + operator: numeric_lt + value: '5' + scope: p22 + allOf: + - $ref: '#/components/schemas/ConditionType' + CustomEventCondition: + description: Search contacts for which an custom event occurred / not occurred + required: + - customEventId + - occurrence + - dateOperator + properties: + customEventId: + description: The custom event identifier + type: string + example: PNM + occurrence: + description: Whether the custom event occurred or not + type: string + enum: + - occurred + - not_occurred + example: occurred + dateOperator: + description: >- + Show contacts for which a custom event occurred / not occurred in + certain date range + type: string + oneOf: + - allOf: + - $ref: '#/components/schemas/SpecificDateExtendedEnum' + - description: Anytime + enum: + - anytime + example: anytime + - description: >- + Allows you to choose a custom date range. The `date` field must + be set to use this operator. + enum: + - date_to + - date_from + - custom + date: + description: >- + The operators `date_to`, `date_from`, and `customDate` require you + to provide, respectively, a date, datetime, or a time interval. + type: string + example: '2018-04-01' + oneOf: + - $ref: '#/components/schemas/SpecificDateType' + - $ref: '#/components/schemas/SpecificDateTimeType' + - $ref: '#/components/schemas/IntervalDateType' + type: object + example: + conditionType: custom_event + customEventId: PNM + occurrence: occurred + dateOperator: date_from + value: '2018-04-01' + allOf: + - $ref: '#/components/schemas/ConditionType' + CreateTransactionalEmail: + required: + - fromField + - subject + - recipients + - contentType + properties: + fromField: + description: The 'From' address ID to be used as the message sender + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The 'From' address ID to be used as the Reply-to + allOf: + - $ref: '#/components/schemas/FromFieldReference' + tag: + description: The tag ID used for statistical data collection + allOf: + - $ref: '#/components/schemas/NewTransactionalEmailTag' + recipients: + $ref: '#/components/schemas/TransactionalEmailRecipients' + contentType: + description: The message content type + type: string + default: direct + enum: + - direct + - template + type: object + discriminator: + propertyName: contentType + mapping: + direct: '#/components/schemas/DirectContent' + template: '#/components/schemas/TemplateContent' + DirectContent: + type: object + allOf: + - $ref: '#/components/schemas/CreateTransactionalEmail' + - $ref: '#/components/schemas/TransactionalEmailContent' + TemplateContent: + type: object + allOf: + - $ref: '#/components/schemas/CreateTransactionalEmail' + - $ref: '#/components/schemas/TransactionalEmailTemplate' + NewTransactionalEmailTag: + required: + - tagId + properties: + tagId: + type: string + example: vBd5 + type: object + TransactionalEmailContent: + required: + - content + properties: + subject: + type: string + maxLength: 512 + minLength: 1 + example: Order Confirmation - Example Shop + attachments: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailAttachment' + content: + description: >- + The message content. At least one field is required. The maximum + combined size of plain text and HTML is 16MB + properties: + plain: + type: string + example: Your order has been confirmed. Thank you for shopping with us! + html: + type: string + example: >- +

Your order has been confirmed

Thank you for + shopping with us! + type: object + type: object + TransactionalEmailTemplate: + description: The template content + required: + - template + properties: + template: + description: The message template. At least templateId is required + required: + - templateId + properties: + templateId: + description: Transactional emails template identifier + type: string + example: Ykz + lexpad: + description: Transactional email lexpad + type: object + example: + some-key: some-value + type: object + type: object + TransactionalEmailRecipients: + required: + - to + properties: + to: + $ref: '#/components/schemas/TransactionalEmailRecipientTo' + cc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipient' + bcc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipient' + type: object + TransactionalEmailRecipientTo: + required: + - email + properties: + validSince: + description: The first time this address appeared in your system + type: string + format: date-time + example: 2018-05-02T09:30:43+0200 + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipient' + TransactionalEmailRecipient: + required: + - email + properties: + email: + type: string + format: email + example: john.doe@example.com + name: + type: string + maxLength: 128 + minLength: 1 + example: John Doe + status: + type: string + enum: + - unknown + - sent + - rejected + - opened + - bounced + - reported_spam + readOnly: true + type: object + TransactionalEmailAttachment: + required: + - fileName + - content + - mimeType + properties: + fileName: + type: string + maxLength: 128 + minLength: 3 + example: pixel.png + mimeType: + description: The MIME attachment type + type: string + maxLength: 128 + minLength: 3 + example: image/png + content: + description: The base64-encoded attachment + type: string + format: base64 + example: >- + iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mOUua1dDwAD4AGjnrXmUAAAAABJRU5ErkJggg== + type: object + TransactionalEmailsTemplateDetails: + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmailsTemplateListElement' + - properties: + content: + $ref: '#/components/schemas/TransactionalEmailTemplateContent' + type: object + TransactionalEmailsTemplateListElement: + properties: + templateId: + description: Transactional email template ID + type: string + readOnly: true + example: p + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api3.getresponse360.com/v3/transactional-emails/templates/tRe4i + subject: + description: The template subject + type: string + example: Order Confirmation Template + createdOn: + description: The creation date + type: string + format: date-time + updatedOn: + description: The date of the last template update + type: string + format: date-time + editor: + description: The Editor type + allOf: + - type: string + enum: + - html + - wysiwyg + type: object + CreateTransactionalEmailTemplate: + required: + - subject + properties: + subject: + description: The template subject + type: string + example: Order Confirmation - Example Shop + content: + $ref: '#/components/schemas/TransactionalEmailTemplateContent' + type: object + TransactionalEmailTemplateContent: + description: The template content. At least one field is required + properties: + plain: + description: The plain text equivalent of template content + type: string + example: Your order has been confirmed. Thank you for shopping with us! + html: + description: The template content in HTML + type: string + example: >- +

Your order has been confirmed

Thank you for shopping + with us! + type: object + TransactionalEmailRecipientStatuses: + properties: + rejectedOn: + type: string + format: date-time + readOnly: true + example: null + nullable: true + openedOn: + type: string + format: date-time + readOnly: true + example: 2019-06-02T09:30:43+0200 + nullable: true + bouncedOn: + type: string + format: date-time + readOnly: true + example: null + nullable: true + complainedOn: + type: string + format: date-time + readOnly: true + example: null + nullable: true + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipientSentOnStatus' + TransactionalEmailRecipientClickedLink: + properties: + url: + type: string + format: uri + readOnly: true + example: https://example.com + clickedOn: + type: string + format: date-time + readOnly: true + example: 2019-06-02T09:31:20+0200 + type: object + TransactionalEmailRecipientDetails: + properties: + statuses: + $ref: '#/components/schemas/TransactionalEmailRecipientStatuses' + clickedLinks: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipientClickedLink' + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipient' + TransactionalEmailRecipientsDetails: + required: + - to + properties: + to: + $ref: '#/components/schemas/TransactionalEmailRecipientDetails' + cc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipientDetails' + bcc: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailRecipientDetails' + type: object + TransactionalEmailDetails: + required: + - transactionalEmailId + - fromField + - subject + - recipients + properties: + fromField: + description: The 'From' address ID to be used as the message sender + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The 'From' address ID to be used as the Reply-to + allOf: + - $ref: '#/components/schemas/FromFieldReference' + subject: + type: string + maxLength: 512 + minLength: 1 + example: Order Confirmation - Example Shop + tag: + description: The tag ID used for statistical data collection + allOf: + - $ref: '#/components/schemas/TransactionalEmailTag' + recipients: + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipientsDetails' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api3.getresponse360.com/v3/transactional-emails/tRe4i + type: object + allOf: + - $ref: '#/components/schemas/TransactionalEmail' + TransactionalEmailTag: + required: + - tagId + properties: + tagId: + type: string + example: vBd5 + type: object + TransactionalEmailRecipientSentOnStatus: + properties: + sentOn: + type: string + format: date-time + readOnly: true + example: 2019-06-02T09:30:43+0200 + nullable: true + type: object + TransactionalEmailListElement: + required: + - transactionalEmailId + - recipients + - fromField + - subject + properties: + transactionalEmailId: + type: string + readOnly: true + example: tRe4i + fromField: + $ref: '#/components/schemas/FromFieldReference' + recipients: + allOf: + - required: + - to + properties: + to: + allOf: + - $ref: '#/components/schemas/TransactionalEmailRecipient' + - properties: + statuses: + $ref: >- + #/components/schemas/TransactionalEmailRecipientSentOnStatus + type: object + type: object + subject: + type: string + maxLength: 512 + minLength: 1 + example: Order Confirmation - Example Shop + tag: + $ref: '#/components/schemas/TransactionalEmailTag' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api3.getresponse360.com/v3/transactional-emails/tRe4i + type: object + TransactionalEmailStatistics: + properties: + timeFrame: + description: >- + The statistics time frame in the ISO 8601 date format with duration + interval + type: string + pattern: >- + /^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?(\/)P(?=\w*\d)(?:\d+Y|Y)?(?:\d+M|M)?(?:\d+W|W)?(?:\d+D|D)?(?:T(?:\d+H|H)?(?:\d+M|M)?(?:\d+(?:\­.\d{1,2})?S|S)?)?$/ + example: 2014-09-20T00:00:00+0000/P2M18DT10H0M0S + sent: + type: integer + format: int64 + opened: + type: integer + format: int64 + bounced: + type: integer + format: int64 + complaint: + type: integer + format: int64 + type: object + TransactionalEmail: + properties: + transactionalEmailId: + type: string + readOnly: true + example: tRe4i + type: object + FromField: + properties: + fromFieldId: + description: The 'From' address ID + type: string + readOnly: true + example: TTzW + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/TTzW + email: + description: The email address + type: string + format: email + example: jsmith@example.com + rewrittenEmail: + description: Email address used to send message. + type: string + format: email + example: jsmith@example.com + nullable: true + name: + description: The name connected to the email address + type: string + maxLength: 64 + minLength: 2 + example: John Smith + isActive: + description: Flag if the 'From' address is active + readOnly: true + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + isDefault: + description: Flag if the 'From' address is default for the account + readOnly: true + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + domain: + properties: + status: + description: Status of domain + type: string + enum: + - confirmed + - unconfirmed + - deleted + - can_not_be_used + - dns_configuration_pending + nullable: true + DKIMWarning: + description: DKIM warning status + type: string + enum: + - not_recommended + - can_not_be_used + - not_authenticated + - at_risk + nullable: true + type: object + type: object + NewFromField: + required: + - email + - name + type: object + allOf: + - $ref: '#/components/schemas/FromField' + FromFieldReference: + required: + - fromFieldId + properties: + fromFieldId: + description: The 'From' address ID + type: string + example: V + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/V + type: object + RssNewsletterDetails: + properties: + clickTracks: + description: The list of tracked links + type: array + items: + $ref: '#/components/schemas/ClickTrack' + flags: + $ref: '#/components/schemas/MessageFlagsArray' + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletter' + RssNewsletterListItem: + properties: + flags: + $ref: '#/components/schemas/MessageFlagsString' + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterListing' + RssNewsletterSendSettingsListing: + required: + - frequency + - filter + properties: + frequency: + description: When to send the message + type: string + example: asap + filter: + description: The filter settings for an RSS post + type: string + enum: + - recent + - engaged + - shared + - commented + maxArticles: + description: How many articles to display in a list + type: integer + format: int32 + maximum: 30 + minimum: 1 + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSuppressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + discriminator: + propertyName: frequency + mapping: + asap: '#/components/schemas/RssNewsletterListSendAsapSettings' + daily: '#/components/schemas/RssNewsletterListSendDailySettings' + weekly: '#/components/schemas/RssNewsletterListSendWeeklySettings' + monthly: '#/components/schemas/RssNewsletterListSendMonthlySettings' + RssNewsletterListSendAsapSettings: + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + RssNewsletterListSendDailySettings: + required: + - sendAtHour + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + RssNewsletterListSendWeeklySettings: + required: + - sendAtHour + - sendAtWeekDay + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + sendAtWeekDay: + description: The day of the week when the message should be sent + type: string + enum: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + RssNewsletterListSendMonthlySettings: + required: + - sendAtHour + - sendAtMonthDay + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + minimum: 0 + sendAtMonthDay: + description: >- + The day of the month when the message should be sent or 31 + representing last day of month + type: integer + format: int32 + maximum: 28 + minimum: 1 + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + RssNewsletterListing: + required: + - rssNewsletterId + - href + properties: + rssNewsletterId: + description: The RSS newsletter ID + type: string + readOnly: true + example: dGer + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/rss-newsletters/dGer + rssFeedUrl: + description: The URL for the RSS Feed + type: string + format: uri + example: http://blog.getresponse.com + subject: + description: The RSS message subject + type: string + maxLength: 255 + minLength: 1 + example: My rss to newsletters + name: + description: How your newsletters will be seen inside the application + type: string + maxLength: 255 + minLength: 1 + example: rsstest0 + status: + description: The status of the RSS newsletter + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + editor: + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + fromField: + description: The 'From' email address used for the message + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The email that will be used as a reply-to address + allOf: + - $ref: '#/components/schemas/FromFieldReference' + content: + $ref: '#/components/schemas/MessageContent' + sendSettings: + description: How the message will be delivered to the subscriber + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsListing' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + MessageSendSettingSelectedCampaigns: + description: The list of campaign IDs to choose subscribers from. + items: + type: string + example: C + MessageSendSettingSelectedSegments: + description: The list of segment IDs to choose subscribers from. + items: + type: string + example: Se + MessageSendSettingSelectedSuppressions: + description: The list of suppression IDs to exclude subscribers. + items: + type: string + example: Ss + MessageSendSettingExcludedCampaigns: + description: The list of campaign IDs to exclude subscribers. + items: + type: string + example: eC + MessageSendSettingExcludedSegments: + description: The list of segment IDs to exclude subscribers. + items: + type: string + example: eSs + MessageSendSettingSelectedContacts: + description: The list of selected contacts. + items: + type: string + example: eSs + BaseCampaign: + properties: + campaignId: + description: Campaign ID + type: string + readOnly: true + example: V3J + name: + description: >- + The campaign (list) name. + + + * You can use each list name just once in your account. + + + * The name must be between 3-64 characters. + + + * All alphabets supported by GetResponse, including right-to-left + ones, are allowed. + + + * You can use upper and lower case letters, numbers, spaces and + special characters apart from the ones listed below. + + + * You can’t use emojis and the following special characters: `/`, + `\`, `@`, and `[` or `]`. + type: string + maxLength: 64 + minLength: 3 + example: my_campaign + techName: + description: >- + Tech name is a unique internal ID of a list used for [FTP + imports](https://www.getresponse.com/help/how-to-import-files-via-ftp.html) + (available in GetResponse MAX accounts only) + type: string + readOnly: true + example: my_campaign + languageCode: + description: >- + The campaign language code according to ISO 639-1, plus: zt - + Chinese (Traditional), fs - Afghan Persian (Dari), md - Moldavian + type: string + example: EN + isDefault: + description: Is the campaign default + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + createdOn: + description: The date of creation + type: string + format: date-time + readOnly: true + example: 2014-02-12T15:19:21+0000 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/campaigns/V3J + type: object + CampaignAdditionalProperties: + properties: + postal: + $ref: '#/components/schemas/CampaignPostal' + confirmation: + $ref: '#/components/schemas/CampaignConfirmation' + optinTypes: + $ref: '#/components/schemas/CampaignOptinTypes' + subscriptionNotifications: + $ref: '#/components/schemas/CampaignSubscriptionNotifications' + profile: + $ref: '#/components/schemas/CampaignProfile' + type: object + Campaign: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseCampaign' + - $ref: '#/components/schemas/CampaignAdditionalProperties' + NewCampaign: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/Campaign' + UpdateCampaign: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/Campaign' + CampaignConfirmation: + properties: + fromField: + $ref: '#/components/schemas/FromFieldReference' + redirectType: + description: >- + What will happen after email confirmation. The values allowed + include: hosted (the subscriber will stay on the default GetResponse + website), customUrl (the subscriber will be redirected to a custom + URL provided by the user). + type: string + enum: + - hosted + - customUrl + example: hosted + mimeType: + description: The MIME type for the confirmation message + type: string + enum: + - text/html + - text/plain + - combo + example: text/plain + redirectUrl: + description: >- + Required if the redirectType is customUrl. The URL a subscriber will + be redirected to if the redirectType is set to customUrl. + type: string + format: uri + example: http://example.com + replyTo: + $ref: '#/components/schemas/FromFieldReference' + subscriptionConfirmationBodyId: + description: The subscription confirmation body ID + type: string + example: asS1 + subscriptionConfirmationSubjectId: + description: Subscription confirmation subject ID + type: string + example: TEww + type: object + CampaignOptinTypes: + properties: + email: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + - double + example: single + api: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + - double + example: single + import: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + example: single + webform: + description: >- + Single opt-in: confirmed opt-in disabled. Double opt-in: confirmed + opt-in enabled. You can find more information + [here](https://www.getresponse.com/resources/glossary/confirmed-opt-in.html) + type: string + enum: + - single + - double + example: single + type: object + CampaignPostal: + properties: + addPostalToMessages: + description: >- + Should the postal address be included in all message footers for + this campaign (mandatory for Canada and the US) + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + city: + description: The city, free-text + type: string + example: London + companyName: + description: The company name, free-text + type: string + example: Company Ltd. + country: + description: The country name, free-text + type: string + example: Great Britain + design: + description: >- + How the postal address will display in messages. The available + fields include: [[name]], [[address]], [[city]], [[state]] [[zip]], + [[country]] + type: string + example: '[[name]] from [[city]] in [[country]]' + state: + description: The state, free-text + type: string + example: Shire + street: + description: The street, free-text + type: string + example: Bilbo Baggins Av + zipCode: + description: The ZIP code + type: string + example: 81-611 + type: object + CampaignProfile: + properties: + description: + description: The campaign description + type: string + maxLength: 255 + minLength: 2 + example: campaign description + industryTagId: + description: The industry tag ID + type: string + format: integer + example: '1' + logo: + description: The logo URL + type: string + format: uri + example: http://logos.com/imageupdated.jpg + logoLinkUrl: + description: The logo link URL + type: string + format: uri + example: http://somePageLogoLinkUpdated.com + title: + description: The profile title + type: string + maxLength: 64 + minLength: 2 + example: title + type: object + CampaignSubscriptionNotifications: + properties: + status: + description: >- + Are notifications enabled. Possible values include: enabled, + disabled. + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + recipients: + type: array + items: + $ref: '#/components/schemas/FromFieldReference' + type: object + UpdateAccount: + type: object + allOf: + - $ref: '#/components/schemas/Account' + Account: + properties: + accountId: + description: Account ID + type: string + readOnly: true + example: VfEy1 + email: + description: Email + type: string + format: email + readOnly: true + example: john.smith@test.com + countryCode: + readOnly: true + $ref: '#/components/schemas/AccountDetailsCountryCode' + industryTag: + readOnly: true + $ref: '#/components/schemas/IndustryTagId' + timeZone: + readOnly: true + allOf: + - $ref: '#/components/schemas/TimezoneName' + - $ref: '#/components/schemas/TimezoneOffset' + href: + description: Direct URL to resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/accounts + firstName: + description: First name + type: string + maxLength: 64 + minLength: 2 + example: John + lastName: + description: Last name + type: string + maxLength: 64 + minLength: 2 + example: Smith + companyName: + description: Company name + type: string + maxLength: 64 + minLength: 2 + example: MyBigCompany + phone: + description: Phone number + type: string + maxLength: 32 + minLength: 2 + example: '+00155555555' + state: + description: State + type: string + maxLength: 40 + minLength: 2 + example: Oklahoma + city: + description: City + type: string + example: Alderson + street: + description: Street + type: string + maxLength: 64 + minLength: 2 + example: Sunset blv. + zipCode: + description: ZIP Code + type: string + maxLength: 9 + minLength: 2 + example: 81-611 + numberOfEmployees: + description: Numbers of employees + type: string + enum: + - '50' + - '250' + - '500' + - more + example: '500' + timeFormat: + description: Account time notation + type: string + enum: + - 12h + - 24h + example: 24h + type: object + AutoresponderTriggerSettings: + required: + - type + - dayOfCycle + - selectedCampaigns + properties: + type: + description: The trigger type + type: string + items: + type: string + enum: + - onday + default: onday + dayOfCycle: + description: >- + For onday type the day of the autoresponder cycle in the 0-9999 + format + type: integer + format: int32 + maximum: 9999 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + autoresponder: + type: string + readOnly: true + nullable: true + newsletter: + type: string + readOnly: true + nullable: true + clickTrackId: + type: string + readOnly: true + nullable: true + goal: + type: string + readOnly: true + nullable: true + custom: + type: string + readOnly: true + nullable: true + newCustomValue: + type: string + readOnly: true + nullable: true + action: + type: string + readOnly: true + nullable: true + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + type: object + AutoresponderSendSettings: + required: + - type + properties: + type: + description: When to send the message + type: string + enum: + - signup + - immediately + - delay + - custom + delayInHours: + description: >- + How many hours to delay the message after a trigger occured, in the + 0-23 format + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + sendAtHour: + description: >- + The specific hour on which the message will be sent, in the 0-23 + format + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + recurrence: + description: >- + Should the message be sent every time the trigger occurs (example: + each click) + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + timeTravel: + description: >- + Should the message be sent in the user's or the subscriber's time + zone + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + excludedDaysOfWeek: + description: >- + The days of the week to exclude from message sending (the message + will be sent on the next non-excluded day after the trigger) + type: array + items: + type: string + enum: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + externalLexpad: + description: >- + External Lexpad settings for the message, read more: [External + Lexpad](https://apidocs.getresponse.com/v3/dynamic-content/external-lexpad) + nullable: true + allOf: + - $ref: '#/components/schemas/ExternalLexpad' + type: object + discriminator: + propertyName: type + mapping: + signup: '#/components/schemas/AutoresponderSendSignupSettings' + immediately: '#/components/schemas/AutoresponderSendImmediatelySettings' + delay: '#/components/schemas/AutoresponderSendDelaySettings' + custom: '#/components/schemas/AutoresponderSendCustomSettings' + AutoresponderSendSignupSettings: + type: object + allOf: + - $ref: '#/components/schemas/AutoresponderSendSettings' + AutoresponderSendImmediatelySettings: + type: object + allOf: + - $ref: '#/components/schemas/AutoresponderSendSettings' + AutoresponderSendDelaySettings: + required: + - delayInHours + type: object + allOf: + - $ref: '#/components/schemas/AutoresponderSendSettings' + AutoresponderSendCustomSettings: + required: + - sendAtHour + type: object + allOf: + - $ref: '#/components/schemas/AutoresponderSendSettings' + Autoresponder: + required: + - autoresponderId + - href + properties: + autoresponderId: + description: The autoresponder ID + type: string + readOnly: true + example: Q + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/autoresponders/Q + name: + description: The autoresponder name + type: string + maxLength: 128 + minLength: 2 + example: Message 2 + subject: + description: The autoresponder message subject + type: string + maxLength: 128 + minLength: 2 + example: test12 + campaignId: + description: >- + The campaign ID. The system will assign the autoresponder to a + default campaign if you don't provide a specific campaign ID. + type: string + example: V + status: + description: The autoresponder status + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + editor: + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + fromField: + description: The from email address used for the message + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The email that will be used as a reply-to address + allOf: + - $ref: '#/components/schemas/FromFieldReference' + content: + $ref: '#/components/schemas/MessageContent' + flags: + $ref: '#/components/schemas/MessageFlagsArray' + sendSettings: + description: How the message will be delivered to the subscriber + allOf: + - $ref: '#/components/schemas/AutoresponderSendSettings' + triggerSettings: + description: 'The conditions that will trigger the autoresponder ' + allOf: + - $ref: '#/components/schemas/AutoresponderTriggerSettings' + statistics: + description: The autoresponder statistics summary + type: object + readOnly: true + allOf: + - properties: + delivered: + type: number + format: float + example: '0' + openRate: + type: number + format: float + example: '0' + clickRate: + type: number + format: float + example: '0' + type: object + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + NewAutoresponder: + required: + - status + - subject + - content + - sendSettings + - triggerSettings + type: object + allOf: + - $ref: '#/components/schemas/Autoresponder' + UpdateAutoresponder: + type: object + allOf: + - $ref: '#/components/schemas/Autoresponder' + RssNewsletterSendSettingsDetails: + required: + - frequency + - filter + properties: + frequency: + description: When to send the message + type: string + example: asap + filter: + description: The filter settings for an RSS post + type: string + enum: + - recent + - engaged + - shared + - commented + maxArticles: + description: How many articles to display in a list + type: integer + format: int32 + maximum: 30 + exclusiveMaximum: false + minimum: 1 + exclusiveMinimum: false + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSuppressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + selectedContacts: + $ref: '#/components/schemas/MessageSendSettingSelectedContacts' + type: object + discriminator: + propertyName: frequency + mapping: + asap: '#/components/schemas/RssNewsletterSendAsapSettings' + daily: '#/components/schemas/RssNewsletterSendDailySettings' + weekly: '#/components/schemas/RssNewsletterSendWeeklySettings' + monthly: '#/components/schemas/RssNewsletterSendMonthlySettings' + RssNewsletterSendAsapSettings: + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + RssNewsletterSendDailySettings: + required: + - sendAtHour + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + RssNewsletterSendWeeklySettings: + required: + - sendAtHour + - sendAtWeekDay + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + sendAtWeekDay: + description: The day of the week when the message should be sent + type: string + enum: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + RssNewsletterSendMonthlySettings: + required: + - sendAtHour + - sendAtMonthDay + properties: + sendAtHour: + description: The hour when the message should be sent + type: integer + format: int32 + maximum: 23 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + sendAtMonthDay: + description: >- + The day of the month when the message should be sent or 31 + representing last day of month + type: integer + format: int32 + oneOf: + - description: Days available for every month + maximum: 28 + minimum: 1 + - description: >- + Represents the last day of month, even if it has less then 31 + days + enum: + - 31 + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + RssNewsletter: + required: + - rssNewsletterId + - href + properties: + rssNewsletterId: + description: The RSS newsletter ID + type: string + readOnly: true + example: dGer + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/rss-newsletters/dGer + rssFeedUrl: + description: The URL for the RSS Feed + type: string + format: uri + example: http://blog.getresponse.com + subject: + description: The RSS message subject + type: string + maxLength: 255 + minLength: 1 + example: My rss to newsletters + name: + description: How your newsletters will be seen inside the application + type: string + maxLength: 255 + minLength: 1 + example: rsstest0 + status: + description: The status of the RSS newsletter + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + editor: + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + fromField: + description: The 'From' email address used for the message + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The email that will be used as a reply-to address + allOf: + - $ref: '#/components/schemas/FromFieldReference' + content: + $ref: '#/components/schemas/MessageContent' + sendSettings: + description: How the message will be delivered to the subscriber + allOf: + - $ref: '#/components/schemas/RssNewsletterSendSettingsDetails' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + NewRssNewsletter: + required: + - rssFeedUrl + - subject + - status + - fromField + - content + - sendSettings + properties: + flags: + $ref: '#/components/schemas/MessageFlagsArray' + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletter' + UpdateRssNewsletter: + properties: + flags: + $ref: '#/components/schemas/MessageFlagsArray' + type: object + allOf: + - $ref: '#/components/schemas/RssNewsletter' + MessageFlagsArray: + description: The message flags. + type: array + items: + type: string + enum: + - openrate + - clicktrack + - google_analytics + MessageFlagsString: + description: >- + Comma-separated list of message flags. The possible values are: + `openrate`, `clicktrack`, and `google_analytics`. + type: string + example: openrate,clicktrack,google_analytics + MessageEditorEnum: + description: >- + How the message was created: `custom` means a custom-made message, + `text` means plain text content, `getresponse` means that the message + was created using the GetResponse editor. + type: string + enum: + - custom + - text + - getresponse + - legacy + - html2 + MessageContent: + description: The message content. + properties: + html: + description: The message content in HTML + type: string + maxLength: 524288 + example: >- +

test 12

Some test http://example.com

+ plain: + description: The plain text equivalent of the message content + type: string + maxLength: 524288 + example: test 12 Some test + type: object + Contact: + required: + - contactId + - href + - email + properties: + contactId: + type: string + readOnly: true + example: pV3r + name: + type: string + maxLength: 128 + minLength: 1 + example: John Doe + origin: + type: string + enum: + - import + - email + - www + - panel + - leads + - sale + - api + - forward + - survey + - iphone + - copy + - landing_page + - website_builder_elegant + readOnly: true + timeZone: + description: >- + The time zone of a contact, uses the time zone database format + (https://www.iana.org/time-zones) + type: string + readOnly: true + example: Europe/Warsaw + activities: + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/contacts/pV3r/activities + changedOn: + type: string + format: date-time + readOnly: true + example: 2017-12-19T13:11:48+0000 + createdOn: + type: string + format: date-time + readOnly: true + example: 2017-03-02T07:30:49+0000 + campaign: + type: object + $ref: '#/components/schemas/CampaignReference' + email: + type: string + format: email + example: john.doe@example.com + dayOfCycle: + description: >- + The day on which the contact is in the Autoresponder cycle. `null` + indicates the contacts is not in the cycle. + type: string + example: '42' + nullable: true + scoring: + description: Contact scoring, pass null to remove the score from a contact + type: number + example: 8 + nullable: true + engagementScore: + description: >- + Engagement Score is a feature that presents a visual estimate of a + contact's engagement with mailings. The score is based on the + contact's interactions with your e-mails. Via API, it's returned in + the form of numbers ranging from 1 (Not Engaged) to 5 (Highly + Engaged). + type: integer + format: int32 + maximum: 5 + minimum: 1 + readOnly: true + example: 3 + nullable: true + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/contacts/pV3r + type: object + NewContactCustomFieldValue: + required: + - customFieldId + - value + properties: + customFieldId: + description: Custom field ID + type: string + example: kL6Nh + value: + type: array + items: + type: string + example: 18-35 + type: object + NewContactTag: + required: + - tagId + properties: + tagId: + type: string + example: m7E2 + type: object + ContactTag: + properties: + tagId: + type: string + example: hR + name: + type: string + example: super_promo + href: + type: string + format: uri + example: https://api.getresponse.com/v3/tags/hR + color: + type: string + deprecated: true + type: object + NewContactTags: + properties: + tags: + type: array + items: + $ref: '#/components/schemas/NewContactTag' + type: object + NewContactCustomFieldValues: + properties: + customFieldValues: + type: array + items: + $ref: '#/components/schemas/NewContactCustomFieldValue' + type: object + NewContact: + required: + - email + - campaign + type: object + allOf: + - $ref: '#/components/schemas/Contact' + - properties: + ipAddress: + description: The contact's IP address. IPv4 and IPv6 formats are accepted. + example: 1.2.3.4 + oneOf: + - type: string + format: ipv4 + - type: string + format: ipv6 + type: object + - $ref: '#/components/schemas/NewContactTags' + - $ref: '#/components/schemas/NewContactCustomFieldValues' + UpsertContactCustomFields: + required: + - customFieldValues + type: object + allOf: + - $ref: '#/components/schemas/NewContactCustomFieldValues' + UpsertContactTags: + required: + - tags + type: object + allOf: + - $ref: '#/components/schemas/NewContactTags' + UpdateContact: + type: object + allOf: + - $ref: '#/components/schemas/Contact' + - properties: + note: + type: string + maxLength: 255 + minLength: 0 + nullable: true + type: object + - $ref: '#/components/schemas/NewContactTags' + - $ref: '#/components/schemas/NewContactCustomFieldValues' + CustomFieldTypeEnum: + type: string + enum: + - text + - textarea + - radio + - checkbox + - single_select + - multi_select + - number + - date + - datetime + - country + - currency + - phone + - gender + - ip + - url + CustomFieldFormatEnum: + type: string + enum: + - text + - textarea + - radio + - checkbox + - single_select + - multi_select + CustomField: + properties: + customFieldId: + description: Custom field ID + type: string + readOnly: true + example: pas + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/custom-fields/pas + name: + description: >- + The name of the custom field. It must meet the following + requirements: + * be unique + * use only lowercase letters, underscores and digits + * not be equal to one of the merge words used in messages, i.e. `name, email, twitter, facebook, buzz, myspace, linkedin, digg, googleplus, pinterest, responder, campaign, change`. + type: string + maxLength: 128 + minLength: 1 + example: office_phone_number + type: + description: |- + The custom field `type` accepts the following values: + * `text` - text input (doesn't require values in the `values` field, you can pass empty array) + * `textarea` - textarea input (does n't require values in the `values` field, you can pass empty array) + * `radio` - radio input (requires at least 2 values in the `values` field) + * `checkbox` - checkbox input (requires at least 2 values in the `values` field) + * `single_select` - single select input (requires at least 2 values in the `values` field) + * `multi_select` - multi select input (requires at least 2 values in the `values` field) + * `number` - text input for a numeric value (doesn't require values in the `values` field, you can pass empty array) + * `date` - text input for a date (doesn't require values in the `values` field, you can pass empty array) + * `datetime` - text input for date and time (doesn't require values in the `values` field, you can pass empty array) + * `country` - multi select input for a country (requires at least 2 country names in the `values` field) + * `currency` - multi select for a currency, allows all ISO 4217 currency codes (requires at least 2 currency codes in the `values` field) + * `phone` - text input for a phone number (doesn't require values in the `values` field, you can pass empty array) + * `gender` - radio input for gender (requires 2 values in the `values` field: `Male` and `Female`, that can be translated into one of the languages supported by GetResponse) + * `ip` - text input for an IP address (doesn't require values in the `values` field, you can pass empty array) + * `url` - text input for a URL (doesn't require values in the `values` field, you can pass empty array). + example: phone + allOf: + - $ref: '#/components/schemas/CustomFieldTypeEnum' + valueType: + description: >- + Type of returning value, it returns `format` options extended by a + `string` option if the `format` was not defined + type: string + enum: + - string + - number + - date + - datetime + - country + - currency + - phone + - gender + - ip + - url + readOnly: true + example: phone + format: + description: |- + The custom field `format` accepts following values: + * `text` - text input (doesn't require values in the `values` field, you can pass empty array) + * `textarea` - textarea input (doesn't require values in the `values` field, you can pass empty array) + * `radio` - radio input (requires at least 2 values in the `values` field) + * `checkbox` - checkbox input (requires at least 2 values in the `values` field) + * `single_select` - single select input (requires at least 2 values in the `values` field) + * `multi_select` - multi select input (requires at least 2 values in the `values` field). + example: text + allOf: + - $ref: '#/components/schemas/CustomFieldFormatEnum' + fieldType: + description: Returns the same data as `type` + type: string + readOnly: true + example: text + deprecated: true + hidden: + description: Whether the custom field is visible to contacts + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + values: + description: >- + The list of assigned values (zero or more - depending on the custom + field type. Please see description) + type: array + items: + type: string + example: '+48600100200' + type: object + NewCustomField: + required: + - name + - type + - hidden + - values + type: object + allOf: + - $ref: '#/components/schemas/CustomField' + UpdateCustomField: + required: + - hidden + - values + properties: + hidden: + description: Whether the custom field is visible to contacts + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + values: + description: >- + The list of assigned values (zero or more - depending on the custom + field type. Please see description) + type: array + items: + type: string + example: '+48600100200' + type: object + NewSuppression: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseSuppression' + UpdateSuppression: + required: + - name + - masks + type: object + allOf: + - $ref: '#/components/schemas/BaseSuppression' + NewPredefinedField: + required: + - name + - value + - campaign + type: object + allOf: + - $ref: '#/components/schemas/PredefinedField' + UpdatePredefinedField: + required: + - value + properties: + value: + type: string + maxLength: 350 + minLength: 1 + pattern: ^[A-Za-z_]{1,350}$ + example: my_new_value + type: object + UpdateCallbacks: + properties: + url: + description: >- + URL to use to post notifications, required if callbacks are not yet + enabled + type: string + format: uri + example: https://example.com/callback + actions: + type: object + $ref: '#/components/schemas/CallbackActions' + type: object + TriggerCustomEvent: + required: + - name + - contactId + properties: + name: + description: >- + The name of custom event. Custom event with this name must already + exist + type: string + maxLength: 64 + minLength: 3 + pattern: ^[a-z0-9_]{3,64}$ + example: lesson_finished + contactId: + description: The contact ID + type: string + example: lTgH5 + attributes: + description: The attributes for the trigger + type: array + items: + $ref: '#/components/schemas/TriggerCustomEventAttribute' + type: object + TriggerCustomEventAttribute: + required: + - name + - value + properties: + name: + description: >- + The name of the attribute. It must be already defined for the custom + event + type: string + maxLength: 64 + minLength: 3 + example: lesson_name + value: + example: lesson_3 + $ref: '#/components/schemas/TriggerCustomEventAttributeValue' + type: object + TriggerCustomEventAttributeValue: + description: >- + The value of the attribute. Value type depends on the attribute + definition + oneOf: + - type: string + maxLength: 255 + minLength: 1 + example: lesson_3 + - $ref: '#/components/schemas/StringBooleanEnum' + - type: boolean + - description: 'Date in extended ISO 8601 datetime format: *2019-01-01T08:00:00+00*' + type: string + format: date-time + example: 2019-01-01T08:00:00+0000 + - type: integer + format: int64 + example: 1500 + NewCustomEvent: + type: object + allOf: + - $ref: '#/components/schemas/CustomEvent' + UpdateCustomEvent: + type: object + allOf: + - $ref: '#/components/schemas/CustomEvent' + CustomEvent: + required: + - name + - attributes + properties: + name: + description: Unique name of custom event + type: string + pattern: ^[a-z0-9_]{3,64}$ + example: sample_custom_event + attributes: + description: Optional collection of attributes + type: array + items: + $ref: '#/components/schemas/CustomEventAttributeDetails' + type: object + CustomEventDetails: + required: + - customEventId + - createdOn + properties: + customEventId: + description: The custom event ID + type: string + readOnly: true + example: hy7 + createdOn: + description: Date of creation custom event definition + type: string + format: date-time + readOnly: true + example: 2019-08-19T11:32:34+0000 + href: + description: Direct hyperlink to a resource + type: string + format: url + readOnly: true + example: https://api.getresponse.com/v3/custom-events/vBd5 + type: object + allOf: + - $ref: '#/components/schemas/CustomEvent' + CustomEventAttributeDetails: + required: + - customEventAttributeId + properties: + customEventAttributeId: + type: string + readOnly: true + example: gt7 + type: object + allOf: + - $ref: '#/components/schemas/CustomEventAttribute' + CustomEventAttribute: + required: + - name + - type + properties: + name: + description: Unique name of attribute + type: string + pattern: ^[a-z0-9_]{3,64}$ + example: sample_attribute + type: + description: Type of attribute + enum: + - string + - number + - datetime + - boolean + example: string + type: object + FormVariant: + properties: + variant: + description: The index of variants + type: string + readOnly: true + example: '0' + variantName: + type: string + example: Variant A + winner: + description: Is this variant the winner in the A/B test + $ref: '#/components/schemas/StringBooleanEnum' + status: + type: string + enum: + - published + - unpublished + - disabled + createdOn: + type: string + format: date-time + example: 2018-07-11T13:37:25+0000 + statistics: + $ref: '#/components/schemas/FormStatistics' + type: object + FormVariantDetails: + properties: + formId: + type: string + readOnly: true + example: pL4e + webformId: + description: Same as `formId` + type: string + readOnly: true + example: pL4e + variant: + description: The index of variants + type: string + readOnly: true + example: '0' + variantName: + type: string + example: Variant A + winner: + description: Is this variant the winner in the A/B test + type: string + enum: + - 'yes' + - 'no' + status: + type: string + enum: + - published + - unpublished + - disabled + createdOn: + type: string + format: date-time + example: 2018-07-09T15:45:12+0000 + numberOfVisitors: + description: The total number of form visitors + type: integer + format: int64 + example: 152 + numberOfUniqueVisitors: + description: The number of unique form visitors + type: integer + format: int64 + example: 136 + numberOfSubscribers: + description: The number of visitors who subscribed through this form + type: integer + format: int64 + example: 94 + subscriptionRate: + description: The ratio of `numberOfSubscribers` to `numberOfVisitors` + type: number + format: double + example: 0.62 + type: object + FormDetails: + type: object + allOf: + - $ref: '#/components/schemas/Form' + - properties: + settings: + $ref: '#/components/schemas/FormSettings' + variants: + type: array + items: + $ref: '#/components/schemas/FormVariant' + type: object + FormSettings: + properties: + optin: + description: >- + `single` - Single opt-in means that the contact will be added + without confirming their subscription first. `double` - Double + opt-in means that the contact will receive a subscription + confirmation email. + type: string + enum: + - single + - double + example: single + phase: + description: >- + The contact who subscribed via this form will be added to the + selected day in the autoresponder cycle. If null, the contact won't + be added to the cycle. + type: integer + format: int32 + maximum: 9999 + minimum: 0 + example: 5 + nullable: true + thankYouType: + description: What should happen when a new contact subscribes via the form. + type: string + enum: + - stay_on_page + - default + - custom_url + example: stay_on_page + thankYouUrl: + description: >- + The URL used to redirect the newly subscribed contacts when they + complete this form. Used if `thankYouType` is `custom_url`. + type: string + format: uri + example: https://example.com/thank-you + nullable: true + alreadySubscribedType: + description: What to do when the address already exists in the campaign + type: string + enum: + - stay_on_page + - default + - custom_url + example: stay_on_page + alreadySubscribedUrl: + description: >- + The URL used to redirect the already subscribed contacts when they + complete this form. Used if `alreadySubscribedType` is `custom_url`. + type: string + format: uri + example: https://example.com/thank-you + nullable: true + secondStageCaptcha: + description: Is captcha enabled for the form + $ref: '#/components/schemas/StringBooleanEnum' + forwardDataRequestType: + description: >- + How to forward form data to a thank-you page. [Learn + more](https://www.getresponse.com/help/building-contact-lists/forms-and-pop-ups/can-i-forward-subscriber-data-to-a-custom-thank-you-page.html). + `null` means that the data forwarding is turned off. + type: string + enum: + - GET + - POST + nullable: true + trackingCustomField: + description: >- + Subscribers added via this form will have this custom field set with + a value passed in `trackingCustomFieldValue` + type: string + nullable: true + $ref: '#/components/schemas/CustomFieldReference' + trackingCustomFieldValue: + description: See the `trackingCustomField` description + type: string + example: '123' + nullable: true + type: object + Form: + properties: + formId: + type: string + readOnly: true + example: pL4e + webformId: + description: Same as `formId` + type: string + readOnly: true + example: pL4e + name: + type: string + example: My first form + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/forms/pL4e + hasVariants: + description: Indicates if the form has variants (A/B tests) + type: boolean + readOnly: true + example: true + scriptUrl: + description: >- + The URL to a JavaScript file of the form. This is used to embed the + form within a web page. + type: string + format: uri + readOnly: true + example: >- + https://app.getresponse.com/view_webform_v2.js?u=nTfa&webforms_id=123 + status: + type: string + enum: + - published + - unpublished + - draft + example: published + createdOn: + type: string + format: date-time + example: 2018-07-02T11:22:33+0000 + statistics: + $ref: '#/components/schemas/FormStatistics' + campaign: + $ref: '#/components/schemas/CampaignReference' + type: object + FormStatistics: + properties: + visitors: + description: The total number of form visitors + type: integer + format: int64 + example: 4371 + uniqueVisitors: + description: The number of unique form visitors + type: integer + format: int64 + example: 3865 + subscribed: + description: The number of visitors that subscribed using this form + type: integer + format: int64 + example: 2594 + subscriptionRate: + description: The ratio of `subscribed` to `visitors` + type: number + format: double + example: 0.59 + type: object + BaseLandingPage: + properties: + landingPageId: + description: The landing page ID + type: string + example: avYn + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/landing-pages/avYn + metaTitle: + description: The landing page meta title property + type: string + example: Some meta title + domain: + description: The domain where the landing page is hosted + type: string + example: gr8.new + subdomain: + description: The subdomain where the landing page is assigned + type: string + example: summer-sale + userDomain: + description: The private domain provided by the user + type: string + example: '' + userDomainPath: + description: The private domain path provided by the user + type: string + example: '' + campaign: + description: The campaign to which the landing page is linked + allOf: + - $ref: '#/components/schemas/CampaignReference' + status: + description: The landing page status + allOf: + - $ref: '#/components/schemas/StatusEnum' + userDomainStatus: + description: >- + The DNS status for the user's private domain. Can be `null` if a + private domain isn't assigned. + type: string + enum: + - active + - inactive + - waiting + nullable: true + testAB: + description: Does the landing page have AB testing (variants) enabled + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + updatedOn: + description: The date of the last page update + type: string + format: date-time + readOnly: true + type: object + LandingPageVariant: + properties: + variantId: + description: The landing page variant ID. + type: string + example: PKxn + variant: + description: The variant index. + type: string + format: integer + example: '0' + winner: + type: boolean + example: true + visitors: + type: string + format: integer + example: '12' + uniqueVisitors: + type: string + format: integer + example: '2' + subscribed: + type: string + format: integer + example: '2' + type: object + LandingPage: + properties: + metaDescription: + description: The landing page meta description property + type: string + example: Some meta description + metaNoindex: + description: >- + To entirely prevent your page content from being listed in the + Google web index, even if other sites link to it use a noindex meta + tag + type: string + enum: + - 'yes' + - 'no' + dayOfCycle: + description: >- + Contacts subscribed via the landing page will be added to the + autoresponder cycle. `Null` if contacts shouldn't be added to the + cycle. + type: integer + format: int32 + maximum: 9999 + minimum: 0 + example: 2 + nullable: true + optin: + description: The opt-in type (double or single) + type: string + enum: + - single + - double + favicoUrl: + description: The favicon URL. Can be `null` if a favicon isn't present + type: string + format: uri + example: https://my-landing-page.mohahaha.com/favico.ico + nullable: true + thankYouPageType: + description: What should happen after a contact subscribes + type: string + enum: + - stay_on_page + - default + - custom_url + thankYouPageUrl: + description: >- + The `thank-you` page URL. Can be empty if a custom thank-you page + isn't being used + type: string + format: uri + example: https://my-landing-page.mohahaha.com/thank_you.html + url: + description: The landing page URL + type: string + format: uri + example: https://my-landing-page.mohahaha.com + variants: + type: array + items: + $ref: '#/components/schemas/LandingPageVariant' + type: object + allOf: + - $ref: '#/components/schemas/BaseLandingPage' + NewImport: + required: + - campaignId + - contacts + - fieldMapping + properties: + campaignId: + description: The ID of the destination campaign (list) + type: string + example: z5c + fieldMapping: + description: >- + Mapping definition for such contact properties as email address, + name, or custom fields. It's the equivalent of column headers in a + CSV file used to import contacts in a GetResponse account. The + `email` value is required. For custom fields, provide only custom + fields name in the mapping. Include their values in the + corresponding field in the contact array + type: array + items: + type: string + example: email + contacts: + description: >- + Container for a contact definition. Include the values defined in + the `fieldMapping` array + type: array + items: + $ref: '#/components/schemas/NewImportContact' + type: object + NewImportContact: + type: array + items: + type: string + example: example@somedomain.com + Import: + properties: + importId: + description: The import ID + type: string + readOnly: true + example: o6gE + campaign: + type: object + $ref: '#/components/schemas/CampaignReference' + status: + type: string + enum: + - uploaded + - review + - approved + - rejected + - finished + - canceled + - to_review + readOnly: true + statistics: + description: The import statistics + type: object + $ref: '#/components/schemas/ImportStatistics' + errorStatistics: + description: The detailed import error statistics + type: object + $ref: '#/components/schemas/ImportErrorStatistics' + createdOn: + type: string + format: date-time + finishedOn: + type: string + format: date-time + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/imports/o6gE + type: object + ImportStatistics: + required: + - uploaded + - invalid + - updated + - addedToList + properties: + uploaded: + description: The number of uploaded contacts + type: integer + format: int64 + readOnly: true + example: 25 + invalid: + description: The number of invalid contacts + type: integer + format: int64 + readOnly: true + example: 5 + updated: + description: The number of updated contacts + type: integer + format: int64 + readOnly: true + example: 10 + addedToList: + description: The number of added contacts + type: integer + format: int64 + readOnly: true + example: 10 + type: object + ImportErrorStatistics: + properties: + syntaxErrors: + description: The number of contacts with a syntax error + type: integer + format: int64 + readOnly: true + example: 2 + alreadyInQueue: + description: The number of contacts already in queue + type: integer + format: int64 + readOnly: true + example: 1 + invalidDomains: + description: The number of contacts with invalid domains + type: integer + format: int64 + readOnly: true + example: 1 + blacklist: + description: The number of blocked contacts + type: integer + format: int64 + readOnly: true + example: 1 + policyFailures: + description: The number of contacts rejected for policy reasons + type: integer + format: int64 + readOnly: true + example: 1 + mismatchedCriteria: + description: >- + The number of contacts rejected because of mismatched criteria, + [learn + more](https://www.getresponse.com/help/managing-contacts/working-with-contact-lists/where-can-i-find-import-statistics.html#what-do-the-numbers-for-uploaded-approved-and-import-errors-mean) + type: integer + format: int64 + readOnly: true + example: 1 + type: object + SmsStats: + required: + - smsId + properties: + smsId: + description: The SMS message ID + type: string + example: PvLI8C + totalSms: + description: The number of SMS messages sent + type: integer + example: 1 + totalRecipients: + description: The number of recipients + type: integer + example: 1 + totalClicks: + description: The number of link clicks from an SMS message + type: integer + example: 1 + totalUnsubscribes: + description: The number of opt-outs from an SMS message + type: integer + example: 1 + totalPrice: + description: Cost details of a specific SMS + type: object + nullable: false + allOf: + - properties: + amount: + description: Total SMS message cost + type: string + example: '0.0240' + currency: + description: Pricing currency + type: string + example: USD + type: object + link: + description: Link details + type: object + nullable: false + allOf: + - properties: + url: + description: Link URL + type: string + example: https://getresponse.com + clicks: + description: The number of link clicks from an SMS message + type: integer + example: 1 + type: object + countryStatistics: + description: SMS message statistics per country + type: object + nullable: false + allOf: + - properties: + countryCode: + description: Country code + type: string + example: PL + recipients: + description: The number of recipients + type: integer + example: 1 + smsCount: + description: The number of messages sent + type: integer + example: 1 + price: + description: Pricing details + type: object + allOf: + - properties: + price: + description: Total cost + type: string + example: '0.0240' + currency: + description: Pricing currency + type: string + example: USD + type: object + type: object + type: object + RevenueStatistics: + properties: + currency: + description: Statistics currency + type: string + example: USD + timeSeries: + type: array + items: + properties: + timeInterval: + description: >- + Orders and revenue are grouped by time intervals. Interval + length is set automatically and depends on the `orderDate` + parameter. + type: string + pattern: >- + /^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?(\/)P(?=\w*\d)(?:\d+Y|Y)?(?:\d+M|M)?(?:\d+W|W)?(?:\d+D|D)?(?:T(?:\d+H|H)?(?:\d+M|M)?(?:\d+(?:\­.\d{1,2})?S|S)?)?$/ + example: 2014-09-20T00:00:00+0000/P2M18DT10H0M0S + revenue: + description: Revenue + type: number + example: 2.45 + orders: + description: Number of orders + type: integer + example: 5 + type: object + type: object + GeneralPerformanceStats: + properties: + currency: + description: Statistics currency + type: string + example: USD + order: + description: Order statistics + type: object + nullable: false + allOf: + - properties: + orders: + description: Number of orders + type: integer + example: 5 + ordersTrend: + description: Order trend + type: number + example: 1.23 + avgOrderRevenue: + description: Average order value + type: number + example: 1.23 + avgOrderRevenueTrend: + description: Average order value trend + type: number + example: 1.23 + type: object + revenue: + description: Revenue statistics + type: object + nullable: false + allOf: + - properties: + revenue: + description: Revenue from orders + type: number + example: 1.23 + revenueTrend: + description: Revenue trend + type: number + example: 1.23 + type: object + type: object + PredefinedField: + properties: + predefinedFieldId: + type: string + readOnly: true + example: 6neM + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/predefined-fields/6neM + name: + type: string + maxLength: 32 + minLength: 1 + pattern: ^[A-Za-z0-9_]{1,32}$ + example: my_predefined_field_123 + value: + type: string + maxLength: 350 + minLength: 1 + example: my value + campaign: + type: object + $ref: '#/components/schemas/CampaignReference' + type: object + PredefinedFieldDetails: + description: The predefined field details. + type: object + readOnly: true + allOf: + - $ref: '#/components/schemas/PredefinedField' + Suppression: + required: + - suppressionId + properties: + suppressionId: + description: The suppression ID + type: string + readOnly: true + example: pypF + name: + description: The suppression name + type: string + example: suppression-name + createdOn: + description: Created on DateTime in the ISO8601 format + type: string + format: date-time + readOnly: true + example: 2018-07-26T06:33:13+0000 + href: + description: Direct hyperlink to a resource + type: string + readOnly: true + example: https://api.getresponse.com/v3/suppressions/pypF + type: object + BaseSuppression: + properties: + name: + description: The name of the suppression list + type: string + example: suppression-name + masks: + type: array + items: + type: string + example: '@example.com' + type: object + SuppressionDetails: + type: object + readOnly: true + allOf: + - $ref: '#/components/schemas/Suppression' + - $ref: '#/components/schemas/BaseSuppression' + SubscriptionConfirmationBody: + properties: + subscriptionConfirmationBodyId: + description: Subscription confirmation subject ID + type: string + example: asS1 + name: + description: Name + type: string + example: Database signup + contentPlain: + description: Plain text content equivalent of confirmation message + type: string + example: > + + Hello {{CONTACT \"subscriber_first_name\"}}, + \r\n \r\n{{INTERNAL \"body\"}}\r\n + + Your request to sign up to our\r\ndatabase has been received + and\r\nrequires your confirmation.\r\n\r\n + + EASY 1-CLICK CONFIRMATION:\r\n{{LINK \"confirm\"}}\r\n\r\nYou will + be added to the database\r\n + + instantly upon your confirmation.\r\n\r\n\r\nYou will be able to + unsubscribe\r\nor change your details at any time.\r\n\r\n + + If you have received this email in\r\nerror and did not intend to + join\r\nour database, no further action is\r\n + + required on your part.\r\n\r\nYou won't receive + further\r\ninformation and you won't be\r\n + + subscribed to any list until you\r\nconfirm your request + above.\r\n\r\n{{INTERNAL \"signature\"}} + contentHtml: + description: HTML content of confirmation message + type: string + example: '[HTML_CODE]' + type: object + SubscriptionConfirmationSubject: + properties: + subscriptionConfirmationSubjectId: + description: Subscription confirmation subject ID + type: string + example: AS3A + subject: + description: Subject + type: string + example: Action Requested - please confirm your subscription. + isPrivate: + description: Is private + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + type: object + ShopDetails: + properties: + shopId: + description: The shop ID + type: string + readOnly: true + example: pf3 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3 + name: + description: The shop name + type: string + maxLength: 124 + minLength: 4 + example: Monster market + locale: + description: The language locale (ISO 639-1) + type: string + example: PL + currency: + description: The currency code (ISO 4217) + type: string + example: PLN + productCount: + description: Amount of products in the shop + type: integer + example: '10' + productRevenue: + description: Total revenue from purchased products + type: number + example: '1.23' + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + PopupGeneralPerformanceStats: + required: + - popupId + properties: + popupId: + description: The form or popup ID + type: string + example: 7189c47e-e45f-4c45-a882-08649c48ff96 + views: + description: The total number of times your popup was viewed by website visitors + type: integer + format: int64 + example: 9 + clicks: + description: The number of clicks + type: integer + format: int64 + example: 2 + ctr: + description: >- + The number of clicks divided by the number of views, shown as a + percentage + type: integer + format: int64 + example: 5 + leads: + description: The number of leads + type: integer + format: int64 + example: 2 + type: object + PopupDetails: + properties: + popupId: + description: The form or popup ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/popups/ce84fabc-1349-4992-a2d7-0c44c5534128 + name: + description: The form or popup name + type: string + example: My popup name + status: + description: The form or popup status + type: string + enum: + - published + - unpublished + readOnly: true + type: + description: The form or popup type + type: string + enum: + - popup + - inline + readOnly: true + thumbnailUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://us-wbe-img2.gr-cdn.com/user/X/Y.webp + createdAt: + description: >- + The date the form or popup was created. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-01T10:35:00`. + type: string + format: date-time + example: '2024-01-01T10:35:00' + updatedAt: + description: >- + The date the form or popup was updated. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-10T10:00:00`. + type: string + format: date-time + example: '2024-01-10T10:00:00' + type: object + PopupListItem: + properties: + popupId: + description: The form or popup ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/popups/6b0d7d59-71d9-4708-80a6-aa0f13805111 + name: + description: The form or popup name + type: string + example: My popup name + status: + description: The form or popup status + type: string + enum: + - published + - unpublished + readOnly: true + type: + description: The form or popup type + type: string + enum: + - popup + - inline + readOnly: true + createdAt: + description: >- + The date the form or popup was created. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-01T10:35:00`. + type: string + format: date-time + updatedAt: + description: >- + The date the form or popup was updated. Shown in format `ISO 8601` + without timezone offset e.g. `2024-01-10T10:00:00`. + type: string + format: date-time + statistics: + description: The landing page statistics + $ref: '#/components/schemas/PopupListItemStatistics' + type: object + PopupListItemStatistics: + properties: + views: + description: The total number of times your popup was viewed by website visitors + type: integer + format: int64 + example: 9 + uniqueVisitors: + description: The total number of visitors + type: integer + format: int64 + example: 10 + leads: + description: The number of leads + type: integer + format: int64 + example: 5 + ctr: + description: >- + The number of clicks divided by the number of views, shown as a + percentage + type: integer + format: int64 + example: 52 + type: object + SplittestNewsletter: + properties: + newsletterId: + description: The newsletter ID + type: string + example: Z6e + href: + description: The direct newsletter URL + type: string + format: uri + example: https://api.getresponse.com/v3/newsletters/B2fvv + name: + description: The newsletter name + type: string + example: Newsletter name + subject: + description: The newsletter subject + type: string + example: Example subject + fromField: + description: The \"From\" address for the newsletter + type: object + $ref: '#/components/schemas/FromFieldReference' + status: + description: The status of the newsletter + type: string + enum: + - sampled + - chosen + - rejected + sendOn: + description: The date when the newsletter was sent + type: string + format: date-time + example: 2015-06-25T20:05:10+0000 + samplingTargets: + description: The newsletter sample targets + type: string + format: int32 + example: '2' + samplingDelivered: + description: The newsletter sample delivery + type: string + format: int32 + example: '2' + scoreOpens: + description: The newsletter open rate + type: string + format: int32 + example: '2' + scoreClicks: + description: The newsletter click rate + type: string + format: int32 + example: '2' + type: object + Splittest: + properties: + splittestId: + description: A/B test ID + type: string + example: A3r + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/splittests/A3r + name: + description: A/B test name + type: string + example: A/B test + campaign: + description: A/B test campaign + type: object + $ref: '#/components/schemas/CampaignReference' + status: + description: A/B test status + type: string + enum: + - active + - inactive + winningCriteria: + description: A/B test winning criteria + type: string + enum: + - open + - click + nullable: true + winningTarget: + description: A/B test wining target + type: string + format: int32 + example: '10' + stage: + description: A/B test stage + type: string + enum: + - queued + - schedule_sampling + - evaluate_sampling + - choose_winning + - schedule_winning + - send_winning + - canceled_queued + - canceled_sampling + - canceled_winning + - incomplete + - finished + type: + description: A/B test type + type: string + enum: + - content + - subject + - day + - hour + - from_field + samplingPercentage: + description: A/B test sample percentage + type: string + format: int32 + example: '18' + nullable: true + samplingTime: + description: A/B test sampling time in seconds + type: string + format: int32 + example: '86400' + nullable: true + chooseWinning: + description: The method of choosing the winning A/B test + type: string + enum: + - automatic + - manual + nullable: true + winningScoreOpens: + description: The open rate of the winning A/B test + type: string + format: int32 + example: '5' + winningScoreClicks: + description: The click rate of the winning A/B test + type: string + format: int32 + example: '3' + winningDelivered: + description: The delivery rate of the winning A/B test + type: string + format: int32 + example: '12' + winningScheduleOn: + description: The date for wchich the winning A/B test was scheduled + type: string + format: date-time + example: 2015-06-25T20:05:10+0000 + nullable: true + nextStepOn: + description: The date of the next step in the A/B test + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + evaluationSkippedOn: + description: The date when the A/B test was skipped + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + canceledOn: + description: The date when the A/B test was canceled + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + createdOn: + description: The date when the A/B test was created + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + newsletters: + description: The newsletters that are associated with the A/B test + type: array + items: + $ref: '#/components/schemas/SplittestNewsletter' + sendSettings: + description: The send settings for the A/B test + properties: + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSupressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + type: object + NewFile: + required: + - name + - extension + - content + - folder + properties: + content: + description: The base64 encoded file content + type: string + format: byte + example: dGVzdCBjb250ZW50 + type: object + allOf: + - $ref: '#/components/schemas/BaseFile' + BaseFile: + properties: + name: + description: The file name + type: string + maxLength: 255 + minLength: 1 + example: image + extension: + description: The file extension + type: string + example: jpg + folder: + description: The folder where the file is stored + nullable: true + allOf: + - $ref: '#/components/schemas/FolderShort' + type: object + FileGroup: + description: The file group + type: string + enum: + - audio + - video + - photo + - document + example: photo + FolderShort: + required: + - folderId + properties: + folderId: + description: The folder ID + type: string + example: 4a9f + type: object + File: + required: + - fileId + properties: + fileId: + description: The file ID + type: string + readOnly: true + example: 6rZ6 + fileSize: + description: The file size + type: integer + format: int64 + readOnly: true + example: 579644 + group: + readOnly: true + $ref: '#/components/schemas/FileGroup' + thumbnail: + description: The direct URL to the file thumbnail + type: string + format: uri + readOnly: true + example: >- + https://us-rs.gr-cdn.com/512x,sBIbGHAUIQfw7kTUjaD0fTzxfXPggsY_1WCWIKl3RAxE=/https://multimedia.getresponse.com/getresponse-ZJtEw/photos/05c53ab1-6119-4076-a96c-bbefa082ea1a.jpg + nullable: true + url: + description: The direct URL to resource + type: string + format: uri + readOnly: true + example: >- + https://multimedia.getresponse.com/getresponse-ZJtEw/photos/05c53ab1-6119-4076-a96c-bbefa082ea1a.jpg + properties: + description: The file properties (available only for the `photos` group) + type: array + items: + $ref: '#/components/schemas/FileProperty' + maxItems: 2 + minItems: 0 + readOnly: true + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + example: 2019-10-12T15:15:49+0000 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/file-library/files/6pS + type: object + allOf: + - $ref: '#/components/schemas/BaseFile' + FileProperty: + required: + - name + - value + properties: + name: + type: string + enum: + - width + - height + readOnly: true + example: width + value: + readOnly: true + oneOf: + - type: integer + example: 1980 + - type: string + type: object + Quota: + properties: + limit: + description: The total size of available storage space + type: integer + format: int64 + example: 1048576 + usage: + description: The currently used storage space + type: integer + format: int64 + example: 1024 + type: object + Folder: + required: + - folderId + properties: + folderId: + description: The folder ID + type: string + readOnly: true + example: t1G + name: + description: The folder name + type: string + maxLength: 128 + minLength: 1 + example: sample folder + size: + description: The size of all files in the directory + type: integer + format: int64 + example: 9564899 + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + example: 2019-10-14T17:17:13+0000 + type: object + NewFolder: + required: + - name + properties: + name: + description: The folder name + type: string + maxLength: 128 + minLength: 1 + example: sample folder + type: object + AbtestsSubjectDetails: + type: object + allOf: + - $ref: '#/components/schemas/AbtestsSubjectListItem' + - properties: + winnerSendingStart: + description: Date the winning message was sent on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + statistics: + description: The statistics of A/B test + properties: + total: + type: object + $ref: '#/components/schemas/AbtestsSubjectStatistics' + winner: + type: object + $ref: '#/components/schemas/AbtestsSubjectStatistics' + type: object + readOnly: true + variants: + type: array + items: + properties: + variantId: + description: >- + The message variant ID. A variant identifier from + https://apireference.getresponse.com/#operation/getAbtestsSubjectById. + type: string + readOnly: true + example: VpKJdr + subject: + description: Variant's subject + type: string + maximum: 150 + minimum: 1 + example: variant + isWinner: + description: Winning variant + type: boolean + readOnly: true + example: true + statistics: + description: Variant's statistics + type: object + readOnly: true + allOf: + - $ref: '#/components/schemas/AbtestsSubjectStatistics' + type: object + sendSettings: + description: The send settings for the A/B test + properties: + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSupressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + editor: + description: The message editor used for the A/B test + type: string + enum: + - html2 + - custom + - text + - editor_v3 + - getresponse + - legacy + nullable: true + content: + $ref: '#/components/schemas/MessageContent' + type: object + AbtestsSubjectStatistics: + properties: + delivered: + description: >- + The total number of delivered messages (winner and variants + combined) + type: integer + example: 10 + openRate: + description: The sum total of opens for the variants and the winner + type: integer + example: 8 + clickRate: + description: The message click rate + type: integer + example: 8 + type: object + AbtestsSubjectListItem: + type: object + allOf: + - $ref: '#/components/schemas/AbtestsSubject' + - properties: + status: + description: Newsletter status + type: string + enum: + - active + - inactive + - deleted + readOnly: true + stage: + description: A/B test stage + type: string + enum: + - preparing + - testing + - finished + - sending_winner + - cancelled + - draft + - completed + readOnly: true + deliverySettings: + description: The A/B test delivery settings + properties: + sendOn: + description: Date the newsletter was sent on + properties: + date: + description: Date the newsletter was sent on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + timeZone: + description: Time zone in which the newsletter was sent + properties: + timeZoneId: + description: ID of the time zone the newsletter was sent in + type: integer + timeZoneName: + description: Name of the time zone the newsletter was sent in + type: integer + nullable: true + timeZoneOffset: + description: >- + Time zone, or UTC, offset for when the newsletter + was sent + type: integer + nullable: true + type: object + type: object + winnerMode: + description: A/B test winner selection mode + type: string + enum: + - automatic + - manual + winningCriteria: + description: A/B test winning criteria + type: string + enum: + - open + - click + samplingPercentage: + description: Size of the test (sampling) group, expressed as a percentage + type: integer + format: int32 + maximum: 50 + minimum: 1 + samplingTime: + description: >- + A/B testing phase duration. The time after which the + remaining recipients will be sent the winning message + type: string + format: ISO-8601 duration + example: '86400' + nullable: true + type: object + flags: + type: array + items: + description: Tracking options enabled for the newsletter + type: string + enum: + - clicktrack + - subscription_reminder + - openrate + - google_analytics + - manual_list + - custom_footer + - ecommerce_tracking + readOnly: true + createdOn: + description: Date the A/B test was created on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + updatedOn: + description: Date A/B test was updated on + type: string + format: date-time + example: 2015-07-25T20:05:10+0000 + nullable: true + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/ab-tests/subject/A3r + type: object + AbtestsSubject: + properties: + abTestId: + description: A/B test ID + type: string + readOnly: true + example: A3r + name: + description: A/B test name + type: string + maxLength: 100 + minLength: 1 + example: A/B test + campaign: + description: List linked to A/B test + properties: + campaignId: + description: Campaign ID + type: string + example: C + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/campaigns/C + name: + description: The campaign name + type: string + readOnly: true + example: Promo campaign + nullable: true + type: object + fromField: + description: Newsletter's From" address" + properties: + fromFieldId: + description: The 'From' address ID + type: string + example: V + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/V + type: object + replyTo: + description: Newsletter's reply-to address + properties: + fromFieldId: + description: The 'From' address ID + type: string + example: V + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/from-fields/V + type: object + type: object + NewAbtestsSubject: + required: + - name + - href + type: object + allOf: + - required: + - name + - campaign + - fromField + properties: + abTestId: + description: A/B test ID + type: string + readOnly: true + example: A3r + name: + description: A/B test name + type: string + maxLength: 100 + minLength: 1 + example: A/B test + campaign: + description: List linked to A/B test + type: object + $ref: '#/components/schemas/CampaignReference' + fromField: + description: Newsletter's From" address" + type: object + $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: Newsletter's reply-to address + type: object + $ref: '#/components/schemas/FromFieldReference' + type: object + - required: + - deliverySettings + - variants + - sendSettings + - content + properties: + deliverySettings: + description: The A/B test delivery settings + required: + - samplingTime + - winningCriteria + - winnerMode + - sendOn + properties: + sendOn: + description: Date the newsletter was sent on + required: + - sendingType + properties: + sendingType: + description: >- + Newsletter send type. Please note that date and timezone + are not allowed with the 'now' option + type: string + enum: + - now + - scheduled + example: scheduled + date: + description: Date the newsletter was sent on + type: string + format: Y-m-d H:i:s + example: '2015-07-25T20:05:10' + nullable: true + timeZone: + description: Time zone in which the newsletter was sent + required: + - date + - timeZoneId + properties: + timeZoneId: + description: ID of the time zone the newsletter was sent in + type: integer + example: 285 + type: object + type: object + winnerMode: + description: A/B test winner selection mode + type: string + enum: + - automatic + - manual + winningCriteria: + description: A/B test winning criteria + type: string + enum: + - open + - click + samplingPercentage: + description: Size of the test (sampling) group, expressed as a percentage + type: integer + format: int32 + maximum: 50 + minimum: 1 + samplingTime: + description: >- + A/B testing phase duration. The time after which the + remaining recipients will be sent the winning message + type: string + format: ISO-8601 duration + example: P0Y0M0DT5H30M0S + nullable: true + type: object + flags: + type: array + items: + description: Tracking options enabled for the newsletter + type: string + enum: + - clicktrack + - google_analytics + - ecommerce_tracking + variants: + description: >- + Message variants. Please note, the number of subject variants + should be between 2 and 5 + required: + - subject + type: array + items: + properties: + subject: + description: Variant's subject + type: string + maximum: 150 + minimum: 1 + example: variant + type: object + sendSettings: + description: The send settings for the A/B test + properties: + selectedCampaigns: + $ref: '#/components/schemas/MessageSendSettingSelectedCampaigns' + selectedSegments: + $ref: '#/components/schemas/MessageSendSettingSelectedSegments' + selectedSupressions: + $ref: '#/components/schemas/MessageSendSettingSelectedSuppressions' + excludedCampaigns: + $ref: '#/components/schemas/MessageSendSettingExcludedCampaigns' + excludedSegments: + $ref: '#/components/schemas/MessageSendSettingExcludedSegments' + type: object + content: + $ref: '#/components/schemas/MessageContent' + type: object + ChooseWinnerAbtestsSubject: + required: + - variantId + properties: + variantId: + description: >- + The message variant ID. A variant identifier from + https://apireference.getresponse.com/#operation/getAbtestsSubjectById. + type: string + example: VpKJdr + type: object + ClickTrackResource: + properties: + clickTrackId: + type: string + example: C12t + name: + description: The name (label) of a click track + type: string + example: Click here + url: + description: The link URL of a click track + type: string + format: uri + example: https://example.com/shop + clicks: + description: The number of clicks counted for a click track + type: integer + format: int64 + example: 25951 + message: + type: object + $ref: '#/components/schemas/ClickTrackMessage' + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/click-tracks/C12t + type: object + ClickTrackMessage: + description: The source message reference for a click track + properties: + resourceId: + description: The ID identifying message resource + type: string + example: r35N + type: + description: The message type + type: string + enum: + - broadcast + - automation + - autoresponder + - rss + - splittest + - sms + example: broadcast + createdOn: + description: The message creation date + type: string + format: date-time + example: 2019-12-01T08:21:28+0000 + resourceType: + description: Type of the resource that represents the message in the API + type: string + enum: + - newsletters + - autoresponders + - rss-newsletters + - splittests + - sms + example: newsletters + href: + description: Direct URL to the resource that represents the message + type: string + format: uri + example: https://api.getresponse.com/v3/newsletters/r35N + type: object + MessageStatisticsListElement: + properties: + timeInterval: + description: >- + The statistics time frame in the ISO 8601 datetime format with + duration interval + type: string + pattern: >- + /^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?(\/)P(?=\w*\d)(?:\d+Y|Y)?(?:\d+M|M)?(?:\d+W|W)?(?:\d+D|D)?(?:T(?:\d+H|H)?(?:\d+M|M)?(?:\d+(?:\­.\d{1,2})?S|S)?)?$/ + example: 2014-09-20T00:00:00+0000/P2M18DT10H0M0S + sent: + type: integer + format: int32 + totalOpened: + type: integer + format: int32 + uniqueOpened: + type: integer + format: int32 + totalClicked: + type: integer + format: int32 + uniqueClicked: + type: integer + format: int32 + goals: + type: integer + format: int32 + uniqueGoals: + type: integer + format: int32 + forwarded: + type: integer + format: int32 + unsubscribed: + type: integer + format: int32 + bounced: + type: integer + format: int32 + complaints: + type: integer + format: int32 + type: object + SendNewsletterDraft: + required: + - messageId + - sendSettings + properties: + messageId: + description: The message identifier (equals to newsletterId) + type: string + example: 'N' + sendOn: + description: >- + The scheduled send date for the message in the ISO 8601 format. + **Please note:** To send your message immediately, omit the `sendOn` + section + type: string + format: date-time + sendSettings: + description: How the message will be delivered to the subscriber + allOf: + - $ref: '#/components/schemas/NewsletterSendSettingsDetails' + type: object + NewsletterAttachment: + properties: + fileName: + description: The file name + type: string + example: some_file.jpg + content: + description: The base64 encoded file content + type: string + format: byte + example: sdfadsfetsdjfdskafdsaf== + mimeType: + description: The file mime type + type: string + example: image/jpeg + type: object + ExternalLexpad: + description: >- + External Lexpad settings for the message, read more: [External + Lexpad](https://apidocs.getresponse.com/v3/dynamic-content/external-lexpad) + required: + - dataSourceUrl + properties: + dataSourceUrl: + description: URL to the endpoint that will provide data for External Lexpad + type: string + format: uri + maxLength: 2048 + minLength: 1 + example: https://example.com/external_lexpad + dataSourceToken: + description: >- + Token that will be sent in `X-Auth-Token` header to authenticate the + requests made to the endpoint + type: string + maxLength: 255 + minLength: 0 + example: cf4dfca78434bf927a7655c0c4d95a2a45c33b71 + nullable: true + type: object + NewsletterSendSettingsDetails: + properties: + selectedCampaigns: + description: The list of selected campaigns + items: + type: string + example: V + selectedSegments: + description: The list of selected segments + items: + type: string + example: S + selectedSuppressions: + description: The list of selected suppressions (suppressions exclude contacts) + items: + type: string + example: Se + excludedCampaigns: + description: The list of excluded campaigns + items: + type: string + example: O + excludedSegments: + description: The list of excluded segments + items: + type: string + example: R + selectedContacts: + description: The list of selected contacts + items: + type: string + example: Qs + timeTravel: + description: >- + Use the time travel functionality. This means that the system will + match the scheduled sending hour for the message to the time zone of + each recipient. As a result, sending may take up to 24 hours. + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + perfectTiming: + description: Use the perfect timing functionality + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + externalLexpad: + description: >- + External Lexpad settings for the message, read more: [External + Lexpad](https://apidocs.getresponse.com/v3/dynamic-content/external-lexpad) + nullable: true + allOf: + - $ref: '#/components/schemas/ExternalLexpad' + type: object + Newsletter: + required: + - newsletterId + - href + properties: + newsletterId: + description: The newsletter ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/newsletters/N + name: + description: The newsletter name + type: string + maxLength: 128 + minLength: 2 + example: New message + type: + description: The newsletter type + type: string + default: broadcast + enum: + - broadcast + - draft + status: + description: The newsletter status + readOnly: true + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + editor: + description: This describes how the content of the message was created + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + subject: + description: The message subject + type: string + maxLength: 128 + minLength: 2 + example: Annual report + fromField: + description: The 'From' email address used for the message + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The email that will be used as the reply-to address + allOf: + - $ref: '#/components/schemas/FromFieldReference' + campaign: + description: The newsletter must be assigned to a campaign + allOf: + - $ref: '#/components/schemas/CampaignReference' + sendOn: + description: >- + The scheduled send date and time for the newsletter in the ISO 8601 + format. + type: string + format: date-time + readOnly: true + attachments: + description: >- + The newsletter attachments. The size of all attachments combined + can't exceed 400KB + type: array + items: + $ref: '#/components/schemas/NewsletterAttachment' + sendSettings: + description: >- + How the message will be delivered to the subscriber. You can specify + multiple parameters. Then the system uses AND logic. + allOf: + - $ref: '#/components/schemas/NewsletterSendSettingsDetails' + sendMetrics: + description: The sending metrics + type: object + readOnly: true + allOf: + - properties: + status: + type: string + default: finished + enum: + - scheduled + - in_progress + - finished + sent: + description: Messages already sent + type: string + default: '0' + total: + description: The total amount of messages to send + type: string + default: '0' + type: object + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + type: object + NewNewsletter: + required: + - subject + - fromField + - campaign + - content + - sendSettings + properties: + content: + $ref: '#/components/schemas/MessageContent' + flags: + $ref: '#/components/schemas/MessageFlagsArray' + name: + description: The newsletter name + type: string + maxLength: 128 + minLength: 2 + example: New message + type: + description: The newsletter type + type: string + default: broadcast + enum: + - broadcast + - draft + editor: + description: This describes how the content of the message was created + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + subject: + description: The message subject + type: string + maxLength: 128 + minLength: 2 + example: Annual report + fromField: + description: The 'From' email address used for the message + allOf: + - $ref: '#/components/schemas/FromFieldReference' + replyTo: + description: The email that will be used as the reply-to address + allOf: + - $ref: '#/components/schemas/FromFieldReference' + campaign: + description: The newsletter must be assigned to a campaign + allOf: + - $ref: '#/components/schemas/CampaignReference' + sendOn: + description: >- + The scheduled send date and time for the newsletter in the ISO 8601 + format. **Please note:** To send your message immediately, omit the + `sendOn` section + type: string + format: date-time + attachments: + description: >- + The newsletter attachments. The size of all attachments combined + can't exceed 400KB + type: array + items: + $ref: '#/components/schemas/NewsletterAttachment' + sendSettings: + description: >- + How the message will be delivered to the subscriber. You can specify + multiple parameters. Then the system uses AND logic. + allOf: + - $ref: '#/components/schemas/NewsletterSendSettingsDetails' + type: object + NewsletterDetails: + properties: + content: + $ref: '#/components/schemas/MessageContent' + clickTracks: + description: The list of tracked links + type: array + items: + $ref: '#/components/schemas/ClickTrack' + flags: + $ref: '#/components/schemas/MessageFlagsArray' + type: object + allOf: + - $ref: '#/components/schemas/Newsletter' + NewsletterListElement: + required: + - newsletterId + - href + properties: + newsletterId: + description: The newsletter ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/newsletters/N + name: + description: The newsletter name + type: string + maxLength: 128 + minLength: 2 + example: New message + type: + description: The newsletter type + type: string + default: broadcast + enum: + - broadcast + - draft + status: + description: The newsletter status + readOnly: true + example: enabled + allOf: + - $ref: '#/components/schemas/StatusEnum' + editor: + description: This describes how the content of the message was created + allOf: + - $ref: '#/components/schemas/MessageEditorEnum' + subject: + description: The message subject + type: string + maxLength: 128 + minLength: 2 + example: Annual report + campaign: + description: The newsletter must be assigned to a campaign + allOf: + - $ref: '#/components/schemas/CampaignReference' + sendOn: + description: >- + The scheduled send date and time for the newsletter in the ISO 8601 + format. + type: string + format: date-time + sendSettings: + description: >- + How the message will be delivered to the subscriber. You can specify + multiple parameters. Then the system uses AND logic. + allOf: + - $ref: '#/components/schemas/NewsletterSendSettingsListing' + sendMetrics: + description: The sending metrics + type: object + readOnly: true + allOf: + - properties: + status: + type: string + default: finished + enum: + - scheduled + - in_progress + - finished + sent: + description: Messages already sent + type: string + default: '0' + total: + description: The total amount of messages to send + type: string + default: '0' + type: object + createdOn: + description: The creation date + type: string + format: date-time + readOnly: true + flags: + $ref: '#/components/schemas/MessageFlagsString' + type: object + NewsletterSendSettingsListing: + properties: + timeTravel: + description: >- + Use the time travel functionality. This means that the system will + match the scheduled sending hour for the message to the time zone of + each recipient. As a result, sending may take up to 24 hours. + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + perfectTiming: + description: Use the perfect timing functionality + example: 'false' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + type: object + ClickTrack: + properties: + clickTrackId: + type: string + example: C + url: + description: The tracked link + type: string + format: uri + example: https://example.com + name: + description: The tracked link name + type: string + example: press here + amount: + description: The number of clicks on a link in a message + type: string + example: '15' + type: object + NewsletterActivity: + properties: + activity: + description: The type of activity + type: string + enum: + - send + - open + - click + createdOn: + description: The date when activity occurred + type: string + format: date-time + example: 2019-10-21T11:08:45+0000 + contact: + description: The contact ID + allOf: + - $ref: '#/components/schemas/NewsletterActivityContactReference' + type: object + NewsletterActivityContactReference: + properties: + contactId: + description: The contact ID + type: string + example: pV3r + email: + description: The contact email + type: string + example: contact@domain.com + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/contacts/pV3r + type: object + NewTag: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseTag' + UpdateTag: + required: + - name + type: object + allOf: + - $ref: '#/components/schemas/BaseTag' + TagDetails: + properties: + tagId: + description: The tag ID. + type: string + readOnly: true + createdAt: + type: string + format: date-time + readOnly: true + example: 2018-07-20T06:24:14+0000 + type: object + allOf: + - $ref: '#/components/schemas/BaseTag' + Tag: + required: + - tagId + - name + - href + - color + - createdAt + properties: + tagId: + description: The tag ID + type: string + readOnly: true + example: vBd5 + href: + description: The direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/tags/vBd5 + createdAt: + type: string + format: date-time + readOnly: true + example: 2020-11-20T08:00:00+0000 + type: object + allOf: + - $ref: '#/components/schemas/BaseTag' + BaseTag: + properties: + name: + description: The tag name + type: string + maxLength: 255 + minLength: 2 + pattern: ^[_a-zA-Z0-9]{2,255}$ + example: My_Tag + color: + description: The tag color (deprecated) + type: string + readOnly: true + deprecated: true + type: object + Blocklist: + properties: + masks: + type: array + items: + type: string + example: jack@somedomain.com + type: object + UpdateBlocklist: + required: + - masks + type: object + allOf: + - $ref: '#/components/schemas/Blocklist' + CustomFieldReference: + required: + - customField + properties: + customFieldId: + type: string + readOnly: true + example: pas + name: + description: >- + + The name of the custom field. It must meet the following + requirements: + * be unique + * use only lowercase letters, underscores and digits: [a-z0-9_]{1,128} + * not be equal to one of the merge words used in messages, i.e. `name`, `email`, `twitter`, `facebook`, `buzz`, `myspace`, `linkedin`, `digg`, `googleplus`, `pinterest`, `responder`, `campaign`, `change`. + type: string + maxLength: 128 + minLength: 1 + example: color + values: + description: >- + The list of assigned default values, starting from zero depending on + the custom field type. (Please see description). + type: array + items: + type: string + example: red + type: object + Lps: + type: object + allOf: + - $ref: '#/components/schemas/LpsListItem' + - properties: + statistics: + description: The landing page statistics + $ref: '#/components/schemas/LpsListItemStatistics' + type: object + LpsListItem: + properties: + lpsId: + description: The landing page ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/lps/6b0d7d59-71d9-4708-80a6-aa0f13805111 + name: + description: The landing page name + type: string + example: 'Predesigned #017' + status: + description: The landing page status + type: string + enum: + - published + - unpublished + readOnly: true + domainUrl: + description: The landing page domain + type: string + format: uri + readOnly: true + example: predesigned-017-52612.grweb.site + thumbnailUrl: + description: The URL of a landing page thumbnail + type: string + format: uri + readOnly: true + example: >- + https://us-wbe-img2.gr-cdn.com/user/e5c2094a-2354-459f-9b9f-6d0369ccae2c/6b0d7d59-71d9-4708-80a6-aa0f13805111.png?width=208 + isChatsEnabled: + description: Chats is enabled on the landing page + example: true + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + createdAt: + description: The date the landing page was created + type: string + format: date-time + updatedAt: + description: The date the landing page was updated + type: string + format: date-time + type: object + LpsListItemStatistics: + properties: + visits: + description: The number of browsing sessions initiated on your landing page + type: integer + format: int64 + example: 9 + leads: + description: Number of leads + type: integer + format: int64 + example: 5 + subscriptionRate: + description: >- + The number of leads divided by the number of visitors, shown as a + percentage + type: integer + format: int64 + example: 52 + type: object + LpsDetails: + type: object + allOf: + - $ref: '#/components/schemas/LpsListItem' + - $ref: '#/components/schemas/LpsDetailsStatistics' + - properties: + pages: + type: array + items: + $ref: '#/components/schemas/LpsPage' + type: object + LpsDetailsStatistics: + properties: + pageViews: + description: The total number of times your landing page was viewed or refreshed + type: integer + format: int64 + example: 9 + visits: + description: The number of browsing sessions initiated on your landing page + type: integer + format: int64 + example: 5 + uniqueVisitors: + description: The number of people who visited your landing page + type: integer + format: int64 + example: 5 + type: object + LpsPage: + properties: + uuid: + description: >- + The ID of a page associated with the landing page (i.e., 404 page + and thank you page) + type: string + readOnly: true + example: 6ee7597f-9bde-4b92-9411-2fb228c9fa34 + name: + description: >- + The name of a page associated with the landing page (i.e., 404 page + and thank you page) + type: string + example: Home + status: + description: >- + The status of a page associated with the landing page (i.e., 404 + page or thank you page) + type: string + enum: + - active + - inactive + url: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: /terms-of-service + redirectUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: '' + createdAt: + description: >- + The date a page associated with the landing page (i.e., 404 page or + thank you page) was created + type: string + format: date-time + type: object + LpsStats: + required: + - lpsId + properties: + lpsId: + description: The landing page ID + type: string + example: 6ee7597f-9bde-4b92-9411-2fb228c9fa34 + name: + type: string + example: Some example landing page + pageViews: + description: The total number of times your landing page was viewed or refreshed + type: integer + format: int64 + example: 9 + visits: + description: The number of browsing sessions initiated on your landing page + type: integer + format: int64 + example: 5 + uniqueVisitors: + description: The number of people who visited your landing page + type: integer + format: int64 + example: 5 + thumbnailUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://us-wbe-img2.gr-cdn.com/user/X/Y.webp + type: object + ImageDetails: + properties: + imageId: + description: Image ID + type: string + example: '123456' + originalImageUrl: + description: URL from which image was downloaded + type: string + format: uri + example: http://somesite.example.com/my_image.jpg + nullable: true + size: + description: Size in bytes + type: string + example: '1234567' + name: + description: Original name + type: string + example: original_image + thumbnailUrl: + description: Thumbnail URL + type: string + format: uri + example: >- + https://us-re.gr-cdn.com/114x/https://multimedia.getresponse.com/getresponse-hUXzv/photos/123456.jpg + url: + description: Asset URL + type: string + format: uri + example: >- + https://multimedia.getresponse.com/getresponse-hUXzv/photos/123456.jpg + extension: + description: File extension + type: string + enum: + - jpg + - gif + - png + - jpeg + - bmp + example: jpg + type: object + CreateMultimedia: + properties: + file: + type: string + format: binary + type: object + Tracking: + properties: + grid: + type: string + readOnly: true + example: 2fEBK5kj4ReCxUvd + snippet: + type: string + readOnly: true + example: >- + + snippetV2: + type: string + readOnly: true + example: + type: object + FacebookPixel: + properties: + name: + type: string + readOnly: true + example: integration-pixel + pixelId: + type: string + readOnly: true + example: '123' + type: object + StatusEnum: + type: string + enum: + - enabled + - disabled + StringBooleanEnum: + type: string + enum: + - 'true' + - 'false' + SortOrderEnum: + type: string + enum: + - ASC + - DESC + DateOrDateTime: + oneOf: + - type: string + format: date + example: '2018-04-15' + - type: string + format: date-time + example: 2018-01-15T13:30:42+0000 + ErrorResponse: + required: + - httpStatus + - code + - codeDescription + - message + - moreInfo + - context + - uuid + properties: + httpStatus: + description: HTTP response code + type: integer + format: int32 + code: + description: API error code + type: integer + format: int32 + codeDescription: + description: API error code description + type: string + message: + description: Error message + type: string + moreInfo: + description: URL to error description in the API Docs + type: string + context: + type: array + items: + type: string + uuid: + description: UUID of the error response + type: string + type: object + AccountBadgeDetails: + properties: + status: + description: Current badge status + example: enabled + $ref: '#/components/schemas/StatusEnum' + type: object + UpdateAccountBadge: + required: + - status + type: object + allOf: + - $ref: '#/components/schemas/AccountBadgeDetails' + SendingLimitsListItem: + properties: + timeFrame: + description: Time frame, measured in seconds + type: integer + example: 2592000 + limit: + description: The number of email sends available within a given time frame + type: integer + example: 2500 + used: + description: The number of email sends used within the given time frame + type: integer + example: 0 + type: object + IndustryTagId: + properties: + industryTagId: + description: Industry tag ID + type: string + format: integer + example: '1' + type: object + IndustryTagProperties: + properties: + name: + type: string + readOnly: true + example: Marketing agencies + description: + type: string + readOnly: true + example: Marketing agencies big and small, with fluent and wise agents... + type: object + IndustryTag: + required: + - industryTagId + type: object + allOf: + - $ref: '#/components/schemas/IndustryTagId' + - $ref: '#/components/schemas/IndustryTagProperties' + TimezoneName: + properties: + name: + description: >- + Time zone name as defined by + https://en.wikipedia.org/wiki/List_of_tz_database_time_zones + type: string + example: Europe/Warsaw + type: object + TimezoneOffset: + properties: + offset: + type: string + pattern: /^(?:Z|[+-](?:2[0-3]|[01][0-9]):[0-5][0-9])$/ + example: '+01:00' + type: object + TimezoneId: + properties: + timezoneId: + type: integer + format: int32 + example: 1 + type: object + TimezoneCountry: + properties: + country: + type: string + example: Poland + type: object + Timezone: + required: + - timezoneId + allOf: + - $ref: '#/components/schemas/TimezoneId' + - $ref: '#/components/schemas/TimezoneName' + - $ref: '#/components/schemas/TimezoneOffset' + - $ref: '#/components/schemas/TimezoneCountry' + AccountsLoginHistoryListElement: + properties: + loginTime: + description: Login time + type: string + format: date-time + example: 2004-02-12T15:19:21+0000 + logoutTime: + description: Logout time + type: string + format: date-time + example: 2004-02-12T15:19:21+0000 + nullable: true + isSuccessful: + description: Login was successful + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + ip: + description: IP address + type: string + format: ipv4 + example: 192.0.0.1 + type: object + CallbackActions: + properties: + open: + description: Is `open` callback enabled + type: boolean + click: + description: Is `click` callback enabled + type: boolean + goal: + description: Is `goal` callback enabled + type: boolean + subscribe: + description: Is `subscribe` callback enabled + type: boolean + unsubscribe: + description: Is `unsubscribe` callback enabled + type: boolean + survey: + description: Is `survey` callback enabled + type: boolean + type: object + Callback: + properties: + url: + description: URL to use to post notifications + format: uri + actions: + $ref: '#/components/schemas/CallbackActions' + type: object + AccountDetailsCountryCode: + properties: + countryCodeId: + description: Country code ID + type: string + example: '175' + countryCode: + description: Country code + type: string + example: PL + type: object + AccountBilling: + properties: + listSize: + description: Billing plan maximum list size + type: string + example: '2500' + paymentPlan: + description: Payment plan + type: string + enum: + - Free Trial + - Monthly + - 12 Months + - 24 Months + example: Monthly + subscriptionPrice: + description: Subscription price + type: integer + example: 25 + renewalDate: + description: Subscription reneval date + type: string + format: date + example: '2017-01-01' + currencyCode: + description: Currency code compliant with ISO-4217 + type: string + example: USD + accountBalance: + description: Account balance + type: string + example: '-15.00' + price: + description: Price + type: integer + example: 25 + paymentMethod: + description: Payment method + type: string + enum: + - outside_system + - inside_system + - credit_card + - platnosci_pl + - direct_debit + - paypal + - yandex + - alipay + - alipay_mobile + - boleto + - ideal + - qiwi + - sofort + - webmoney + example: credit_card + creditCard: + type: object + nullable: true + allOf: + - properties: + number: + description: Masked credit card number + type: string + example: XXXXXXXXX0123 + type: object + - properties: + expirationDate: + description: Expiration date + type: string + format: date + example: '2014-01-01' + type: object + addons: + description: Addons + type: array + items: + properties: + name: + description: Addon name + type: string + example: Landing Page Creator + price: + description: Addon price + type: integer + example: 15 + active: + description: Addon active status + example: 'true' + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + type: object + type: object + SubscriptionsByDatesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignSubscriptionStatisticsList' + CampaignSubscriptionStatisticsList: + description: Dates in the YYYY-MM-DD format are used as keys. + type: object + example: + '2014-12-15': + V: + import: 10 + email: 11 + www: 10 + panel: 14 + leads: 3 + sale: 3 + api: 1 + forward: 15 + survey: 6 + mobile: 12 + copy: 7 + landing_page: 4 + summary: 99 + p: + import: 9 + email: 7 + www: 9 + panel: 5 + leads: 3 + sale: 3 + api: 8 + forward: 10 + survey: 8 + mobile: 10 + copy: 10 + landing_page: 7 + summary: 93 + additionalProperties: + description: Dates in YYYY-MM-DD format are used as keys + type: object + allOf: + - $ref: '#/components/schemas/CampaignSubscriptionStatisticsItemByCampaign' + CampaignRemovalsStatisticsItem: + type: object + anyOf: + - properties: + api: + type: integer + example: 1 + type: object + - properties: + automation: + type: integer + example: 1 + type: object + - properties: + blacklisted: + type: integer + example: 1 + type: object + - properties: + bounce: + type: integer + example: 1 + type: object + - properties: + cleaner: + type: integer + example: 1 + type: object + - properties: + compliant: + type: integer + example: 1 + type: object + - properties: + support: + type: integer + example: 1 + type: object + - properties: + unsubscribe: + type: integer + example: 1 + type: object + - properties: + user: + type: integer + example: 1 + type: object + CampaignSubscriptionStatisticsItemByCampaign: + description: The properties of the result are indexed with the campaign ID. + type: object + example: + V: + import: 10 + email: 11 + www: 10 + panel: 14 + leads: 3 + sale: 3 + api: 1 + forward: 15 + survey: 6 + mobile: 12 + copy: 7 + landing_page: 4 + webinar: 3 + summary: 99 + p: + import: 9 + email: 7 + www: 9 + panel: 5 + leads: 3 + sale: 3 + api: 8 + forward: 10 + survey: 8 + mobile: 10 + copy: 10 + landing_page: 7 + webinar: 4 + summary: 93 + additionalProperties: + description: The properties of the result are indexed with the campaign ID + $ref: '#/components/schemas/CampaignSubscriptionStatisticsItem' + CampaignSubscriptionStatisticsItem: + properties: + import: + type: integer + example: 0 + email: + type: integer + example: 0 + www: + type: integer + example: 0 + panel: + type: integer + example: 0 + leads: + type: integer + example: 0 + sale: + type: integer + example: 0 + api: + type: integer + example: 0 + forward: + type: integer + example: 0 + survey: + type: integer + example: 0 + mobile: + type: integer + example: 0 + copy: + type: integer + example: 0 + landing_page: + type: integer + example: 0 + webinar: + type: integer + example: 0 + summary: + type: integer + example: 0 + type: object + CampaignSummaryList: + type: array + items: + $ref: '#/components/schemas/CampaignSummaryItem' + CampaignLocationsList: + type: array + items: + $ref: '#/components/schemas/CampaignLocationItem' + RemovalsByDatesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignRemovalsStatisticsList' + CampaignRemovalsStatisticsList: + type: object + example: + '2014-12-05': + user: 5 + '2015-01-22': + user: 12 + bounce: 2 + additionalProperties: + description: Dates in YYYY-MM-DD format are used as keys + $ref: '#/components/schemas/CampaignRemovalsStatisticsItem' + CampaignLocationItem: + type: object + example: + others: + amount: '6' + continentCode: '' + countryCode: '' + PL: + amount: '45' + continentCode: EU + countryCode: PL + additionalProperties: + description: The results are indexed with the location name (PL, EN, etc.) + properties: + amount: + description: The amount of subscribers from a given location + type: string + format: number + example: '0' + continentalCode: + description: The region code + type: string + example: EU + countryCode: + description: The country code + type: string + example: PL + type: object + CampaignOriginsList: + type: array + items: + $ref: '#/components/schemas/CampaignSubscriptionStatisticsItemByCampaign' + CampaignListSizesStatisticsElement: + properties: + totalSubscribers: + description: The total amount of subscribers for a given datetime and grouping + type: integer + format: int64 + addedSubscribers: + description: The amount of subscribers added since the previous statistics frame + type: integer + format: int64 + removedSubscribers: + description: >- + The amount of subscribers removed since the previous statistics + frame + type: integer + format: int64 + createdOn: + description: >- + The statistics frame timestamp. The value depends on the groupBy + parameter. For the hour, use datetime in the format YYYY-mm-dd + HH:mm:ss; for the day, use date in the format YYYY-mm-dd; for the + month, use a string in the format YYYY-mm; and for the total, use + the string total. + type: string + type: object + CampaignListSizesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignListSizesStatisticsElement' + BalanceByDatesStatisticsList: + type: array + items: + $ref: '#/components/schemas/CampaignBalanceStatisticsList' + CampaignBalanceStatisticsList: + type: object + example: + '2014-12-05': + removals: + user: 5 + subscriptions: + import: 0 + email: 0 + www: 0 + panel: 0 + leads: 0 + sale: 0 + api: 7 + forward: 0 + survey: 0 + mobile: 0 + copy: 0 + landing_page: 0 + summary: 7 + '2015-01-21': + removals: + user: 10 + additionalProperties: + description: Dates in YYYY-MM-DD format are used as keys + anyOf: + - properties: + removals: + type: object + allOf: + - $ref: '#/components/schemas/CampaignRemovalsStatisticsItem' + type: object + - properties: + subscriptions: + type: object + allOf: + - $ref: '#/components/schemas/CampaignSubscriptionStatisticsItem' + type: object + CampaignSummaryItem: + description: >- + The properties of the result are indexed with the location name (PL, EN, + etc.). + type: object + example: + o5lx: + totalSubscribers: '4' + totalNewsletters: '129' + totalTriggers: '0' + totalLandingPages: '1' + totalWebforms: '3' + CC9F: + totalSubscribers: '0' + totalNewsletters: '0' + totalTriggers: '0' + totalLandingPages: '5' + totalWebforms: '0' + V6OeR: + totalSubscribers: '0' + totalNewsletters: '0' + totalTriggers: '0' + totalLandingPages: '0' + totalWebforms: '0' + additionalProperties: + properties: + totalSubscribers: + description: The total number of subscribers + type: string + format: number + example: '0' + totalNewsletters: + description: The total number of newsletters + type: string + format: number + example: '0' + totalTriggers: + description: The total number of triggers + type: string + format: number + example: '0' + totalLandingPages: + description: The total number of landing pages + type: string + format: number + example: '0' + totalWebforms: + description: The total number of webforms + type: string + format: number + example: '0' + type: object + CampaignListElement: + properties: + description: + description: It's the same as the campaign name, kept for compatibility reasons + type: string + readOnly: true + example: my_campaign + type: object + allOf: + - $ref: '#/components/schemas/BaseCampaign' + CampaignReference: + required: + - campaignId + properties: + campaignId: + description: Campaign ID + type: string + example: C + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/campaigns/C + name: + description: The campaign name + type: string + readOnly: true + example: Promo campaign + nullable: true + type: object + CampaignStatisticsIdQuery: + type: string + example: 3Va2e + LegacyForm: + properties: + webformId: + description: The webform (Legacy Form) ID + type: string + example: NPKx + name: + type: string + example: Webform 2010/7/5 + href: + description: Direct hyperlink to a resource + type: string + format: uri + example: https://api.getresponse.com/v3/webforms/NPKx + scriptUrl: + description: The URL of the script that displays the Legacy Form + type: string + format: uri + example: https://app.getresponse.com/view_webform.js?u=VfEy1&wid=11774901 + status: + $ref: '#/components/schemas/StatusEnum' + modifiedOn: + description: The modification date + type: string + format: date-time + statistics: + $ref: '#/components/schemas/LegacyFormStatistics' + campaign: + $ref: '#/components/schemas/CampaignReference' + type: object + LegacyFormStatistics: + properties: + opened: + description: The number of Legacy Form views + type: integer + format: int64 + example: 1234 + subscribed: + description: The number of contacts that subscribed using this Legacy Form + type: integer + format: int64 + example: 100 + type: object + GDPRField: + properties: + gdprFieldId: + type: string + readOnly: true + example: MtY + name: + description: The name of the GDPR field + type: string + example: 'Consent #1' + createdOn: + type: string + format: date-time + example: 2018-08-01T09:18:00+0000 + href: + description: The direct hyperlink to the resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/gdpr-fields/MtY + type: object + GDPRFieldLatestVersion: + properties: + gdprFieldVersionId: + type: string + readOnly: true + example: yRI + content: + description: The content of the GDPR field + type: string + readOnly: true + example: '1st version of Consent #1' + createdOn: + type: string + format: date-time + example: 2018-08-02T11:12:00+0000 + type: object + GDPRFieldDetails: + type: object + allOf: + - $ref: '#/components/schemas/GDPRField' + - properties: + latestVersion: + $ref: '#/components/schemas/GDPRFieldLatestVersion' + type: object + UpdateWorkflow: + required: + - status + properties: + status: + description: >- + An 'incomplete' status means that the workflow is a 'draft' in the + web panel + type: string + enum: + - active + - inactive + - incomplete + example: active + type: object + Workflow: + required: + - workflowId + - name + - status + - subscriberStatistics + properties: + workflowId: + description: The workflow ID + type: string + readOnly: true + example: pxs + name: + type: string + example: My draft + status: + type: string + enum: + - active + - inactive + - incomplete + example: active + dateStart: + type: string + format: date-time + example: 2014-02-12T15:19:21+0000 + dateStop: + type: string + format: date-time + example: 2014-04-12T15:19:21+0000 + subscriberStatistics: + $ref: '#/components/schemas/WorkflowSubscriberStatistics' + type: object + WorkflowSubscriberStatistics: + required: + - completedCount + - inProgressCount + properties: + completedCount: + description: The number of subscribers that completed the workflow + type: integer + format: int64 + readOnly: true + example: 4 + inProgressCount: + description: The number of subscribers that are in progress in the workflow + type: integer + format: int64 + readOnly: true + example: 3 + type: object + SmsDetails: + properties: + sendSettings: + description: How the message will be delivered to the subscriber + type: object + nullable: true + allOf: + - properties: + contacts: + description: >- + The details of recipients who are in your contact list + (recipientsType = \"contacts\"). If the recipient is not in + your GetResponse contacts, the property is null. + nullable: true + allOf: + - properties: + selectedCampaigns: + $ref: >- + #/components/schemas/MessageSendSettingSelectedCampaigns + selectedSegments: + $ref: >- + #/components/schemas/MessageSendSettingSelectedSegments + excludedCampaigns: + $ref: >- + #/components/schemas/MessageSendSettingExcludedCampaigns + excludedSegments: + $ref: >- + #/components/schemas/MessageSendSettingExcludedSegments + selectedContacts: + description: The list of contact IDs. + items: + type: string + example: V2 + type: object + importedNumbers: + description: >- + The details of recipients whose numbers are imported + (recipientsType = \"importedNumbers\"). If the recipient is + in your GetResponse contacts, the property is null. + nullable: true + allOf: + - properties: + count: + description: Number of phone numbers entered manually + type: integer + example: 10 + type: object + type: object + clickTracks: + description: >- + Details of links attached to SMS message. Maximum 20 links will be + returned. + type: array + items: + allOf: + - properties: + clickTrackId: + description: The click track ID + type: string + example: a2 + href: + description: Direct hyperlink to a resource + type: string + example: https://api.getresponse.com/v3/click-tracks/a2 + url: + description: The link URL + type: string + example: https://example.com + label: + description: The link label + type: string + example: example-link + amount: + description: Number of clicks on a link + type: integer + example: 2 + uniqueAmount: + description: Number of unique clicks on link + type: integer + example: 1 + type: object + type: object + allOf: + - $ref: '#/components/schemas/SmsListItem' + SmsAutomationListItem: + required: + - smsId + properties: + smsId: + description: The automated SMS message ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/sms-automation/N + name: + description: The automated SMS message name + type: string + maxLength: 128 + minLength: 2 + example: New message + campaign: + description: The campaign the SMS message is in + allOf: + - $ref: '#/components/schemas/CampaignReference' + modifiedOn: + description: >- + The date the automated SMS message was last modified on, shown in + `ISO 8601` date and time format. e.g. `2022-04-10T10:02:57+0000` + type: string + format: date-time + status: + description: The status of of the automated SMS message + type: string + enum: + - ready + - in_use + statistics: + description: Automate SMS message statistics + allOf: + - properties: + sent: + description: The number od sent automated SMS messages + type: integer + example: 12 + delivered: + description: The number of delivered automated SMS messages + type: integer + example: 10 + clicks: + description: The number of automated SMS link clicks + type: integer + example: 8 + type: object + senderName: + description: The name of the sender of the automated SMS message + type: string + readOnly: true + hasLinks: + description: Information is the automated SMS message contains links + type: boolean + readOnly: true + type: object + SmsListItem: + required: + - newsletterId + - href + properties: + smsId: + description: The SMS message ID + type: string + readOnly: true + example: 'N' + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/sms/N + name: + description: The SMS message name + type: string + maxLength: 128 + minLength: 2 + example: New message + campaign: + description: The SMS message campaign + allOf: + - $ref: '#/components/schemas/CampaignReference' + modifiedOn: + description: >- + The date the SMS message was last modified on, shown in `ISO 8601` + date and time format. e.g. `2022-04-10T10:02:57+0000` + type: string + format: date-time + type: + description: The SMS message type + type: string + enum: + - sms + - draft + readOnly: true + sendOn: + description: SMS message send date details + type: object + nullable: true + allOf: + - properties: + date: + description: >- + Send date. Shown in format `ISO 8601` without timezone + offset e.g. `2022-04-10T10:02:57`. + type: string + format: date-time + example: '2022-03-26T10:35:00' + timeZone: + description: Time zone details + type: object + allOf: + - properties: + timeZoneId: + description: Time zone ID + type: integer + example: '123' + timeZoneName: + description: Time zone name + type: string + example: America/New_York + timeZoneOffset: + description: Time zone offset + type: string + example: '-05:00' + type: object + type: object + recipientsType: + description: Type of SMS message recipients + type: string + enum: + - contacts + - importedNumbers + readOnly: true + example: contacts + senderName: + description: The SMS message sender name + type: string + readOnly: true + content: + description: The SMS message content + type: string + example: This is my SMS content + sendMetrics: + description: Information about sending process + type: object + allOf: + - properties: + progress: + description: Sending progress + type: string + status: + description: Sending status + type: string + enum: + - scheduled + - sending + - sent + type: object + statistics: + description: Message statistics + allOf: + - properties: + sent: + description: Number of sent messages + type: integer + example: 12 + delivered: + description: Number of delivered messages + type: integer + example: 10 + clicks: + description: Number of clicked messages + type: integer + example: 8 + type: object + type: object + AutoresponderDetails: + properties: + clickTracks: + description: The list of tracked links + type: array + items: + $ref: '#/components/schemas/ClickTrack' + campaign: + description: The autoresponder campaign (list) + allOf: + - $ref: '#/components/schemas/CampaignReference' + type: object + allOf: + - $ref: '#/components/schemas/Autoresponder' + AutoresponderList: + type: array + items: + properties: + campaign: + description: The autoresponder campaign (list) + allOf: + - $ref: '#/components/schemas/CampaignReference' + type: object + allOf: + - $ref: '#/components/schemas/Autoresponder' + Website: + properties: + websiteId: + description: The website ID + type: string + readOnly: true + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: >- + https://api.getresponse.com/v3/websites/6b0d7d59-71d9-4708-80a6-aa0f13805111 + name: + description: The website name + type: string + example: 'Predesigned #017' + status: + description: The website status + type: string + enum: + - published + - unpublished + readOnly: true + domainUrl: + description: The website domain + type: string + format: uri + readOnly: true + example: predesigned-017-52612.grweb.site + thumbnailUrl: + description: The URL of a website thumbnail + type: string + format: uri + readOnly: true + example: >- + https://us-wbe-img2.gr-cdn.com/user/e5c2094a-2354-459f-9b9f-6d0369ccae2c/6b0d7d59-71d9-4708-80a6-aa0f13805111.png?width=208 + isChatsEnabled: + description: Chats is enabled on the website + example: true + allOf: + - $ref: '#/components/schemas/StringBooleanEnum' + createdAt: + description: The date the website was created + type: string + format: date-time + updatedAt: + description: The date the website was updated + type: string + format: date-time + statistics: + description: The website statistics + $ref: '#/components/schemas/WebsiteStatistics' + type: object + WebsiteStatistics: + properties: + pageViews: + description: Number of page views + type: integer + format: int64 + example: 9 + visits: + description: Number of site visits + type: integer + format: int64 + example: 5 + uniqueVisitors: + description: Number of unique visitors + type: integer + format: int64 + example: 5 + type: object + WebsiteStats: + required: + - websiteId + properties: + websiteId: + description: The website ID + type: string + example: PvLI8C + name: + type: string + example: Variant A + pageViews: + description: The number of page views + type: integer + example: 1 + visits: + description: The number of visits + type: integer + example: 1 + uniqueVisitors: + description: The number of unique visitors + type: integer + example: 1 + thumbnailUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/wbe/N + type: object + WebsiteDetails: + type: object + allOf: + - $ref: '#/components/schemas/Website' + - properties: + pages: + type: array + items: + $ref: '#/components/schemas/WebsitePage' + type: object + WebsitePage: + properties: + uuid: + description: The website page ID + type: string + readOnly: true + example: 6ee7597f-9bde-4b92-9411-2fb228c9fa34 + name: + description: The website page name + type: string + example: Home + status: + description: The website page status + type: string + enum: + - active + - inactive + url: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: /terms-of-service + redirectUrl: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: '' + createdAt: + description: The date the website page was created + type: string + format: date-time + type: object + responses: + WebinarDetails: + description: The webinar details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Webinar' + WebinarList: + description: The list of webinars + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Webinar' + UpsertContactTags: + description: ' The list of contact tags.' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactTag' + ContactActivityList: + description: The list of contact activities. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactActivity' + ContactCustomFieldList: + description: The list of custom fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactCustomFieldList' + ContactList: + description: The list of contacts. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ContactListElement' + ContactDetails: + description: The contact details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ContactDetails' + BaseSearchContactsList: + description: The saved search contact. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BaseSearchContactsDetails' + SearchContactsDetails: + description: Search contact details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SearchContactsDetails' + SearchedContactsList: + description: The contact list. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SearchedContactDetails' + TransactionalEmailsTemplateDetails: + description: Transactional emails template details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionalEmailsTemplateDetails' + TransactionalEmailsTemplateList: + description: Transactional email templates listing + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailsTemplateListElement' + TransactionalEmailDetails: + description: Transactional email details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionalEmailDetails' + TransactionalEmailStatistics: + description: The overall statistics of transactional emails + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailStatistics' + TransactionalEmailList: + description: The list of transactional emails + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TransactionalEmailListElement' + TransactionalEmail: + description: Transactional email. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionalEmail' + FromFieldList: + description: The list of 'From' email addresses ('from fields'). + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FromField' + FromFieldDetails: + description: The 'From' address details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/FromField' + RssNewsletterDetails: + description: The RSS newsletter details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/RssNewsletterDetails' + RssNewsletterList: + description: The list of RSS newsletters. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RssNewsletterListItem' + TaxDetails: + description: The tax details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Tax' + TaxList: + description: The list of taxes + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tax' + CustomEventDetails: + description: The custom event details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEventDetails' + CustomEventsList: + description: The list of custom events + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomEventDetails' + FormVariantList: + description: The list of form variants. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FormVariantDetails' + FormDetails: + description: The form details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/FormDetails' + FormList: + description: The list of forms. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Form' + LandingPageList: + description: The list of landing pages. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BaseLandingPage' + LandingPageDetails: + description: The landing pages details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LandingPage' + ImportList: + description: The list of imports. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Import' + ImportDetails: + description: The import details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Import' + SmsStats: + description: SMS statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsStats' + RevenueStats: + description: Revenue statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/RevenueStatistics' + GeneralPerformanceStats: + description: General performance statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/GeneralPerformanceStats' + PredefinedFieldsList: + description: The list of predefined fields. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PredefinedField' + PredefinedFieldDetails: + description: The predefined field details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/PredefinedField' + CategoryDetails: + description: The category details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Category' + CategoryList: + description: The list of categories + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Category' + SuppressionsList: + description: The suppressions list. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Suppression' + SuppressionDetails: + description: The suppression details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SuppressionDetails' + OrderList: + description: The list of orders + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Order' + OrderDetails: + description: The order details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/OrderResponse' + SubscriptionConfirmationBodyList: + description: List of subscription confirmation bodies + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SubscriptionConfirmationBody' + SubscriptionConfirmationSubjectList: + description: List of subscription confirmation subjects + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SubscriptionConfirmationSubject' + ProductList: + description: The list of products + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Product' + SimpleProductCategoryList: + description: The list of product categories + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BaseCategory' + ProductDetails: + description: The product details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Product' + ShopList: + description: The list of shops + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + properties: + shopId: + description: The shop ID + type: string + readOnly: true + example: pf3 + href: + description: Direct hyperlink to a resource + type: string + format: uri + readOnly: true + example: https://api.getresponse.com/v3/shops/pf3 + name: + description: The shop name + type: string + maxLength: 124 + minLength: 4 + example: Monster market + locale: + description: The language locale (ISO 639-1) + type: string + example: PL + currency: + description: The currency code (ISO 4217) + type: string + example: PLN + type: object + allOf: + - $ref: '#/components/schemas/CreateAndUpdate' + ShopDetails: + description: The shop details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ShopDetails' + PopupGeneralPerformance: + description: Form or popup statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/PopupGeneralPerformanceStats' + PopupDetails: + description: Form or popup details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/PopupDetails' + PopupsList: + description: The list of forms and popups + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PopupListItem' + SplittestList: + description: The list of A/B tests. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Splittest' + Splittest: + description: A/B test details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Splittest' + CartDetails: + description: The cart details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + CartList: + description: The list of carts + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Cart' + Quota: + description: Storage space information + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Quota' + FileList: + description: The list of files + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/File' + File: + description: The file details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/File' + Folder: + description: The folder details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Folder' + FoldersList: + description: The list of folders + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Folder' + AbtestsSubjectGetDetails: + description: A/B test details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AbtestsSubjectDetails' + AbtestsSubjectGetList: + description: The list of A/B tests + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AbtestsSubjectListItem' + ClickTrack: + description: The click track details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ClickTrackResource' + ClickTrackList: + description: The list of click tracks + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ClickTrackResource' + MessageStatisticsListElement: + description: The message statistics. + content: + application/json: + schema: + $ref: '#/components/schemas/MessageStatisticsListElement' + NewsletterDetails: + description: The newsletter details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/NewsletterDetails' + NewsletterList: + description: The list of newsletters. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NewsletterListElement' + NewsletterActivities: + description: The list of newsletters activities + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NewsletterActivity' + TagDetails: + description: The tag details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/TagDetails' + TagList: + description: The list of tags + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tag' + AddressList: + description: The list of addresses. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Address' + AddressDetails: + description: The address details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Address' + AccountBlocklist: + description: Blocklist masks for the whole account. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Blocklist' + CampaignBlocklist: + description: Blocklist masks for the campaign. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Blocklist' + CustomFieldDetails: + description: The custom field details. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CustomField' + CustomFieldList: + description: The list of custom fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CustomField' + LpsList: + description: The list of tags + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Lps' + LpsDetails: + description: The landing page details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/LpsDetails' + LpsStats: + description: Landing page statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/LpsStats' + ImageList: + description: Image list + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ImageDetails' + ImageDetails: + description: Image details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ImageDetails' + Tracking: + description: The Tracking Snippets + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tracking' + FacebookPixelList: + description: '"Facebook Pixel" details' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FacebookPixel' + ProductVariantDetails: + description: The product variant details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/ProductVariant' + ProductVariantList: + description: The list of product variants + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProductVariant' + AccountBadgeDetails: + description: Account badge status + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AccountBadgeDetails' + SendingLimitsList: + description: Send limits + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SendingLimitsListItem' + IndustryList: + description: Industry tags list + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IndustryTag' + AccountTimezoneList: + description: List of time zones + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Timezone' + AccountLoginHistoryList: + description: Login history information + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AccountsLoginHistoryListElement' + Callback: + description: Callback configuration + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Callback' + AccountDetails: + description: Your account information + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Account' + AccountBillingDetails: + description: Billing information. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AccountBilling' + SubscriptionsByDatesStatisticsList: + description: Subscription statistics by date + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionsByDatesStatisticsList' + CampaignSummaryList: + description: The summary list. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignSummaryList' + CampaignLocationsList: + description: The list of locations. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignLocationsList' + RemovalsByDatesStatisticsList: + description: Subscription statistics by date + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/RemovalsByDatesStatisticsList' + CampaignOriginsList: + description: The list of origins. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignOriginsList' + CampaignListSizesStatisticsList: + description: The campaign data. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignListSizesStatisticsList' + BalanceByDatesStatisticsList: + description: The subscription statistics, shown by date. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/BalanceByDatesStatisticsList' + Campaign: + description: The campaign data. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Campaign' + CampaignList: + description: The list of campaigns. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CampaignListElement' + MetaFieldDetails: + description: The meta field details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/MetaField' + MetaFieldList: + description: The list of meta fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetaField' + LegacyForm: + description: The Legacy Form. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/LegacyForm' + LegacyFormList: + description: The list of Legacy Forms. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LegacyForm' + GDPRFieldList: + description: The list of GDPR fields + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GDPRField' + GDPRFieldDetails: + description: The details of the GDPR field + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/GDPRFieldDetails' + Workflow: + description: The workflow + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/Workflow' + WorkflowList: + description: The list of workflows + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Workflow' + SmsDetails: + description: The SMS message details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsDetails' + SmsAutomationList: + description: The list of the automated SMS messages + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsAutomationListItem' + SmsList: + description: The SMS message listing + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/SmsListItem' + MessageStatisticsList: + description: The list of autoresponders statistic split by time interval. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MessageStatisticsListElement' + SingleMessageStatisticsList: + description: The list of autoresponder statistics split by time interval. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MessageStatisticsListElement' + AutoresponderDetails: + description: The autoresponder details' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/AutoresponderDetails' + AutoresponderList: + description: The list of autoresponders. + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + $ref: '#/components/schemas/AutoresponderList' + WebsitesList: + description: The list of tags + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + CurrentPage: + $ref: '#/components/headers/CurrentPage' + TotalPages: + $ref: '#/components/headers/TotalPages' + TotalCount: + $ref: '#/components/headers/TotalCount' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Website' + WebsiteStats: + description: Website statistics + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/WebsiteStats' + WebsiteDetails: + description: The website details + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/RateLimitLimit' + X-RateLimit-Remaining: + $ref: '#/components/headers/RateLimitRemaining' + X-RateLimit-Reset: + $ref: '#/components/headers/RateLimitReset' + content: + application/json: + schema: + $ref: '#/components/schemas/WebsiteDetails' + parameters: + webinarId: + name: webinarId + in: path + description: The webinar ID + required: true + schema: + type: string + example: yK6d + contactId: + name: contactId + in: path + description: The contact ID + required: true + schema: + type: string + example: pV3r + searchContactId: + name: searchContactId + in: path + description: The saved search contact identifier + required: true + schema: + type: string + example: pV3r + transactionalTemplateId: + name: transactionalTemplateId + in: path + description: Transactional emails template identifier + required: true + schema: + type: string + example: abc + transactionalEmailId: + name: transactionalEmailId + in: path + required: true + schema: + type: string + example: tRe4i + fromFieldId: + name: fromFieldId + in: path + description: The 'From' address ID + required: true + schema: + type: string + example: TTzW + rssNewsletterId: + name: rssNewsletterId + in: path + description: The RSS newsletter ID + required: true + schema: + type: string + example: dGer + taxId: + name: taxId + in: path + description: The tax ID + required: true + schema: + type: string + example: Sk + customEventId: + name: customEventId + in: path + description: The custom event ID + required: true + schema: + type: string + example: hp2 + formId: + name: formId + in: path + description: The form ID + required: true + schema: + type: string + example: pL4e + landingPageId: + name: landingPageId + in: path + description: The landing page ID. + required: true + schema: + type: string + example: avYn + importId: + name: importId + in: path + description: The import ID + required: true + schema: + type: string + example: o6gE + predefinedFieldId: + name: predefinedFieldId + in: path + description: The predefined field identifier + required: true + schema: + type: string + example: 6neM + categoryId: + name: categoryId + in: path + description: The category ID + required: true + schema: + type: string + example: C3s + suppressionId: + name: suppressionId + in: path + description: The suppression ID + required: true + schema: + type: string + example: pypF + orderId: + name: orderId + in: path + description: The order ID + required: true + schema: + type: string + example: fOh + languageCode: + name: languageCode + in: path + description: ISO 639-1 Language Code Standard + required: true + schema: + type: string + example: en + productId: + name: productId + in: path + description: The product ID + required: true + schema: + type: string + example: 9I + shopId: + name: shopId + in: path + description: The shop ID + required: true + schema: + type: string + example: pf3 + popupId: + name: popupId + in: path + description: The form or popup ID + required: true + schema: + type: string + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + splittestId: + name: splittestId + in: path + description: The send settings for the A/B test + required: true + schema: + type: string + example: 9I + cartId: + name: cartId + in: path + description: The cart ID + required: true + schema: + type: string + example: V + fileId: + name: fileId + in: path + description: The file ID + required: true + schema: + type: string + example: 6Yh + folderId: + name: folderId + in: path + description: The folder ID + required: true + schema: + type: string + example: Pa5 + abTestId: + name: abTestId + in: path + description: A/B test ID + required: true + schema: + type: string + example: xyz + clickTrackId: + name: clickTrackId + in: path + required: true + schema: + type: string + example: C12t + newsletterId: + name: newsletterId + in: path + description: The newsletter ID + required: true + schema: + type: string + example: 'N' + tagId: + name: tagId + in: path + description: The tag ID + required: true + schema: + type: string + example: vBd5 + addressId: + name: addressId + in: path + description: The address ID + required: true + schema: + type: string + example: k9 + customFieldId: + name: customFieldId + in: path + description: The custom field ID + required: true + schema: + type: string + example: pas + lpsId: + name: lpsId + in: path + description: The landing page ID + required: true + schema: + type: string + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + variantId: + name: variantId + in: path + description: The variant ID + required: true + schema: + type: string + example: VTB + campaignId: + name: campaignId + in: path + description: The campaign ID + required: true + schema: + type: string + example: 3Va2e + CampaignStatisticsIdQuery: + name: query[campaignId] + in: query + required: true + schema: + $ref: '#/components/schemas/CampaignStatisticsIdQuery' + CampaignStatisticsGroupByQuery: + name: query[groupBy] + in: query + required: false + schema: + type: string + enum: + - hour + - day + - month + - total + example: month + CampaignStatisticsDateFromQuery: + name: query[createdOn][from] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + CampaignStatisticsDateToQuery: + name: query[createdOn][to] + in: query + required: false + schema: + $ref: '#/components/schemas/DateOrDateTime' + metaFieldId: + name: metaFieldId + in: path + description: The metafield ID + required: true + schema: + type: string + example: hgF + webformId: + name: webformId + in: path + description: The webform (Legacy Form) ID + required: true + schema: + type: string + example: 3Va2e + gdprFieldId: + name: gdprFieldId + in: path + description: The GDPR field ID + required: true + schema: + type: string + example: MtY + workflowId: + name: workflowId + in: path + description: The workflow ID + required: true + schema: + type: string + example: 3Va2e + smsId: + name: smsId + in: path + description: The SMS message ID + required: true + schema: + type: string + example: 'N' + autoresponderId: + name: autoresponderId + in: path + description: The autoresponder ID. + required: true + schema: + type: string + example: Q + websiteId: + name: websiteId + in: path + description: The website ID + required: true + schema: + type: string + example: ce84fabc-1349-4992-a2d7-0c44c5534128 + PerPage: + name: perPage + in: query + description: Requested number of results per page + required: false + schema: + type: integer + format: int32 + default: 100 + maximum: 1000 + minimum: 1 + Page: + name: page + in: query + description: Page number + required: false + schema: + type: integer + format: int32 + default: 1 + minimum: 1 + Fields: + name: fields + in: query + description: >- + List of fields that should be returned. Id is always returned. Fields + should be separated by comma + required: false + schema: + type: string + requestBodies: + NewShop: + content: + application/json: + schema: + $ref: '#/components/schemas/NewShop' + NewCategory: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCategory' + UpdateCategory: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCategory' + UpdateShop: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateShop' + NewMetaField: + content: + application/json: + schema: + $ref: '#/components/schemas/NewMetaField' + NewProduct: + content: + application/json: + schema: + $ref: '#/components/schemas/NewProduct' + UpdateProduct: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateProduct' + UpsertProductCategory: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertProductCategory' + UpsertMetaField: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertMetaField' + UpdateMetaField: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMetaField' + NewProductVariant: + content: + application/json: + schema: + $ref: '#/components/schemas/NewProductVariant' + UpdateProductVariant: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateProductVariant' + NewTax: + content: + application/json: + schema: + $ref: '#/components/schemas/NewTax' + UpdateTax: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateTax' + NewAddress: + content: + application/json: + schema: + $ref: '#/components/schemas/NewAddress' + UpdateAddress: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAddress' + NewOrder: + content: + application/json: + schema: + $ref: '#/components/schemas/NewOrder' + UpdateOrder: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateOrder' + NewCart: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCart' + UpdateCart: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCart' + NewSearchContacts: + content: + application/json: + schema: + $ref: '#/components/schemas/NewSearchContacts' + UpdateSearchContacts: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSearchContacts' + SearchContactsConditionsDetails: + content: + application/json: + schema: + $ref: '#/components/schemas/SearchContactsConditionsDetails' + CreateTransactionalEmail: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTransactionalEmail' + CreateTransactionalEmailTemplate: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTransactionalEmailTemplate' + updateTransactionalEmailsTemplate: + content: + application/json: + schema: + properties: + subject: + description: The template subject + type: string + example: Order Confirmation - Example Shop + content: + $ref: '#/components/schemas/TransactionalEmailTemplateContent' + type: object + NewFromField: + content: + application/json: + schema: + $ref: '#/components/schemas/NewFromField' + NewCampaign: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCampaign' + UpdateCampaign: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCampaign' + UpdateAccount: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAccount' + NewAutoresponder: + content: + application/json: + schema: + $ref: '#/components/schemas/NewAutoresponder' + UpdateAutoresponder: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAutoresponder' + NewRssNewsletter: + content: + application/json: + schema: + $ref: '#/components/schemas/NewRssNewsletter' + UpdateRssNewsletter: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRssNewsletter' + NewContact: + content: + application/json: + schema: + $ref: '#/components/schemas/NewContact' + UpsertContactCustomFields: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertContactCustomFields' + UpsertContactTags: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertContactTags' + UpdateContact: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateContact' + NewCustomField: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCustomField' + UpdateCustomField: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCustomField' + NewSuppression: + content: + application/json: + schema: + $ref: '#/components/schemas/NewSuppression' + UpdateSuppression: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSuppression' + NewPredefinedField: + content: + application/json: + schema: + $ref: '#/components/schemas/NewPredefinedField' + UpdatePredefinedField: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePredefinedField' + UpdateCallbacks: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCallbacks' + TriggerCustomEvent: + content: + application/json: + schema: + $ref: '#/components/schemas/TriggerCustomEvent' + NewCustomEvent: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCustomEvent' + UpdateCustomEvent: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCustomEvent' + NewImport: + content: + application/json: + schema: + $ref: '#/components/schemas/NewImport' + NewFile: + content: + application/json: + schema: + $ref: '#/components/schemas/NewFile' + NewFolder: + content: + application/json: + schema: + $ref: '#/components/schemas/NewFolder' + NewAbtestsSubject: + content: + application/json: + schema: + $ref: '#/components/schemas/NewAbtestsSubject' + ChooseWinnerAbtestsSubject: + content: + application/json: + schema: + $ref: '#/components/schemas/ChooseWinnerAbtestsSubject' + SendNewsletterDraft: + content: + application/json: + schema: + $ref: '#/components/schemas/SendNewsletterDraft' + NewNewsletter: + content: + application/json: + schema: + $ref: '#/components/schemas/NewNewsletter' + NewTag: + content: + application/json: + schema: + $ref: '#/components/schemas/NewTag' + UpdateTag: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateTag' + UpdateAccountBlocklist: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlocklist' + UpdateCampaignBlocklist: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlocklist' + CreateMultimedia: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/CreateMultimedia' + UpdateAccountBadge: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAccountBadge' + UpdateWorkflow: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateWorkflow' + headers: + CurrentPage: + description: The current page number + schema: + type: integer + format: int32 + TotalPages: + description: The total number of pages + schema: + type: integer + format: int32 + TotalCount: + description: The total number of resources found for the specified conditions + schema: + type: integer + format: int32 + RateLimitLimit: + description: The total number of requests available per time frame + schema: + type: integer + format: int32 + RateLimitRemaining: + description: The number of requests left in the current time frame + schema: + type: integer + format: int32 + RateLimitReset: + description: Seconds left in the current time frame, e.g. "432 seconds" + schema: + type: string + securitySchemes: + api-key: + type: apiKey + description: Header value must be prefixed with api-key + name: X-Auth-Token + in: header + oauth2: + type: oauth2 + flows: + implicit: + authorizationUrl: https://app.getresponse.com/oauth2_authorize.html + scopes: + all: all data access + authorizationCode: + authorizationUrl: https://app.getresponse.com/oauth2_authorize.html + tokenUrl: https://api.getresponse.com/v3/token + scopes: + all: all data access + clientCredentials: + tokenUrl: https://api.getresponse.com/v3/token + scopes: + all: all data access +tags: + - name: Webinars + - name: Contacts + - name: Search Contacts + - name: Transactional Email Templates + - name: Transactional Emails + - name: From Fields + - name: RSS Newsletters + - name: Taxes + - name: Custom Events + - name: Forms + - name: Legacy Landing Pages + - name: Imports + - name: Predefined Fields + - name: Categories + - name: Suppressions + - name: Orders + - name: Subscription Confirmations + - name: Products + - name: Shops + - name: Forms and Popups + - name: A/B tests + - name: Carts + - name: File Library + - name: A/B tests - subject + - name: Click Tracks + description: >- + Click tracking refers to the data collected about each link click, such as + how many people clicked it, how many clicks resulted in desired actions + such as sales, forwards or subscriptions. + - name: Newsletters + - name: Tags + - name: Addresses + - name: Custom Fields + - name: New Landing Pages + - name: Multimedia + - name: Tracking + - name: Product Variants + - name: Accounts + - name: Campaigns (Lists) + description: >- + Our API v3 uses the terminology from the previous version of GetResponse. + + + **Campaigns and lists are the same resource under a different name.** For + now, please refer to lists as campaigns. + + + Our API v4 will use the updated terminology. + - name: Meta Fields + - name: Legacy Forms + - name: Workflows + - name: SMS Automation Messages + - name: SMS Messages + - name: Autoresponders + - name: Websites +externalDocs: + description: Find out more about API + url: https://apidocs.getresponse.com +x-tagGroups: + - name: User + tags: + - Accounts + - Multimedia + - File Library + - name: Contacts + tags: + - Campaigns (Lists) + - Contacts + - Custom Fields + - Search Contacts + - Subscription Confirmations + - Predefined Fields + - Suppressions + - Imports + - name: Email Marketing + tags: + - Newsletters + - Autoresponders + - RSS Newsletters + - Legacy Landing Pages + - From Fields + - A/B tests + - A/B tests - subject + - Click Tracks + - name: Tags + tags: + - Tags + - name: GDPR Fields + tags: + - GDPR Fields + - name: Forms and surveys + tags: + - Legacy Forms + - Forms + - name: Automation + tags: + - Workflows + - Custom Events + - Tracking + - name: Ecommerce + tags: + - Addresses + - Carts + - Categories + - Meta Fields + - Orders + - Products + - Product Variants + - Shops + - Taxes + - name: Transactional Emails + tags: + - Transactional Emails + - Transactional Emails Templates + - name: SMS + tags: + - SMS Messages + - SMS Automation Messages + - name: Statistics + tags: + - Ecommerce + - Sms + - Website + - Landing Page + - Form and Popup + - name: Webinars + tags: + - Webinars + - name: Websites + tags: + - Websites + - Landing Pages + - name: Forms and Popups + tags: + - Forms and Popups diff --git a/sdks/db/processed-custom-request-cache/getresponse.com.yaml b/sdks/db/processed-custom-request-cache/getresponse.com.yaml new file mode 100644 index 0000000000..6b116df7c3 --- /dev/null +++ b/sdks/db/processed-custom-request-cache/getresponse.com.yaml @@ -0,0 +1,529 @@ +processed: + securitySchemes: + api-key: + type: apiKey + description: Header value must be prefixed with api-key + name: X-Auth-Token + in: header + oauth2: + type: oauth2 + flows: + implicit: + authorizationUrl: https://app.getresponse.com/oauth2_authorize.html + scopes: + all: all data access + authorizationCode: + authorizationUrl: https://app.getresponse.com/oauth2_authorize.html + tokenUrl: https://api.getresponse.com/v3/token + scopes: + all: all data access + clientCredentials: + tokenUrl: https://api.getresponse.com/v3/token + scopes: + all: all data access + apiBaseUrl: https://api.getresponse.com/v3 + apiVersion: 3.2024-03-04T09:53:07+0000 + apiDescription: > + + + # Limits and throttling + + + GetResponse API calls are subject to throttling to ensure a high level of + service for all users. + + + ## Time frame + + + Time frame is a period of time for which we calculate the API call limits. + The limits reset in every time frame. + + + The time frame duration is **10 minutes**. + + + ## Basic rate limits + + + Each user is allowed to make **30,000 API calls per time frame** (10 + minutes) and **80 API calls per second**. + + + ## Parallel requests limit + + + It is possible to send up to **10 simultaneous requests**. + + + ## Headers + + + Every API response includes a few additional headers: + + + * `X-RateLimit-Limit` – the total number of requests available per time + frame + + * `X-RateLimit-Remaining` – the number of requests left in the current + time frame + + * `X-RateLimit-Reset` – seconds left in the current time frame + + + ## Errors + + + The **429 Too Many Requests** HTTP response code indicates that the limit + has been reached. The error response includes `currentLimit` and + `timeToReset` fields in the context section, with the total number of + requests available per time frame and seconds left in the current time frame + respectively. + + + ## Reaching the limit + + + When you reach the limit, you need to wait for the time specified in + `timeToReset` field or `X-RateLimit-Reset` header before making another + request. + + + # Authentication + + + API can be accessed by authenticated users only. This means that every + request must be signed with your credentials. We offer two methods of + authentication: API Key and OAuth 2.0. API key is our primary method and + should be used in most cases. GetResponse MAX clients have to send an + `X-Domain` header in addition to the API key. Supported OAuth 2.0 flows are: + Authorization Code, Client Credentials, Implicit, and Refresh Token. + + + ## API key + + + Follow these steps to send an authentication request: + + + * Find your unique and secret API key in the panel: + [https://app.getresponse.com/api](https://app.getresponse.com/api) + + * Add a custom `X-Auth-Token` header to all your requests. For example, if + your API key is `jfgs8jh4ksg93ban9Dfgh8`, the header will look like this: + + + ``` + + X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8 + + ``` + + + **For security reasons, unused API keys expire after 90 days. When that + happens, you’ll need to generate a new key to use our API.** + + + ### Example authenticated request + + + ``` + + $ curl -H "X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8" + https://api.getresponse.com/v3/accounts + + ``` + + + ## OAuth 2.0 + + + To use OAuth 2.0 authentication, you need to get an "Access Token". For more + information on how to obtain a token, head to our dedicated page: [OAuth + 2.0](/#section/Authentication/Using-OAuth-2.0) + + + To authenticate a request using an Access Token, set the value of + `Authorization` header to "Bearer" followed by the Access Token. + + + ### Example + + + If the Access Token is `jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8` + + + ``` + + Authorization: Bearer jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8 + + ``` + + + ## GetResponse MAX + + + GetResponse MAX customers need to take an extra step to authenticate the + request. All requests have to be send with an `X-Domain` header that + contains the client's domain. For example: + + + ``` + + X-Domain: example.com + + ``` + + + Please note that the header must contain only the domain name, without the + protocol identifier (`http://` or `https://`). + + + ## Using OAuth 2.0 + + + ### Registering your own application + + + If you want to use an OAuth flow to authorize your application, first + [register your application](https://app.getresponse.com/authorizations) + + + You need to provide a name, short description, and redirect URL. + + + ### Choosing grant flow + + + Once your application is registered, you can click on it to see your + `client_id` and `client_secret`. They're basically a login and password for + your application's access, so be sure not to share them with anyone. + + + Next, decide which authentication flow (grant type) you want to use. Here + are your options: + + + - choose the **Authorization Code** flow if your application is server-based + (you have a server with its own domain and server-side code), + + - choose the **Implicit** flow if your application is based mostly on + JavaScript or client-side code, + + - choose the **Client Credential** flow if you want to test your application + or access your GetResponse account, + + - implement the **Refresh Token** flow to handle token expiration if you use + the Authorization Code flow. + + + ### Authorization Code flow + + + First, your application must redirect a resource owner to the following URL: + + + ``` + + https://app.getresponse.com/oauth2_authorize.html?response_type=code&client_id=_your_client_id_&state=xyz + + ``` + + + The `state` parameter is there for security reasons and should be a random + string. When the resource owner grants your application access to the + resource, we will redirect the browser to the `redirect URL` you specified + in the application settings and attach the same state as the parameter. + Comparing the state parameter value ensures that the redirect was initiated + by our system. The code parameter is an authorization code that you can + exchange for an access token within 10 minutes, after which time it expires. + + + #### Example redirect with authorization code + + + ``` + + https://myredirecturi.com/cb?code=ed17c498bfe343175cd7684c5b09979f2875b25c&state=xyz + + ``` + + + #### Exchanging authorization code for the access token + + + Here's an example request to exchange authorization code for the access + token: + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=authorization_code&code=ed17c498bfe343175cd7684c5b09979f2875b25c' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + ##### Example response + + + ```json + + { + "access_token": "03807cb390319329bdf6c777d4dfae9c0d3b3c35", + "expires_in": 3600, + "token_type": "Bearer", + "scope": null, + "refresh_token": "170d9f64e781aaa6b3ba036083faba71b2fc4e6c" + } + + ``` + + + ### Client Credentials flow + + + This flow is suitable for development, when you need to quickly access API + to create some functionality. You can get the access token with a single + request: + + + #### Request + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=client_credentials' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + #### Response + + + ```json + + { + "access_token": "e2222af2851a912470ec33c9b4de1ea3a304b7d7", + "expires_in": 86400, + "token_type": "Bearer", + "scope": null + } + + ``` + + + You can also go to https://app.getresponse.com/manage_api.html, click the + action button for your application, and select "generate credentials". This + will open a popup with a generated access token. You can then use the access + token to authenticate your requests, for example: + + + ``` + + $ curl -H "Authorization: Bearer e2222af2851a912470ec33c9b4de1ea3a304b7d7" + https://api.getresponse.com/v3/from-fields + + ``` + + + ### Implicit flow + + + First, your application must redirect a resource owner to the following URL: + + + ``` + + https://app.getresponse.com/oauth2_authorize.html?response_type=token&client_id=_your_client_id_&redirect_uri=https://myredirecturi.com/cb&state=xyz + + ``` + + + When the resource owner grants your application access to the resource, we + will redirect the owner to the URL that was specified in the request. + + + There is no code exchange process because, unlike the Authorization Code + flow, the redirect already has the access token in the parameters. + + + ``` + + https://myredirecturi.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA&state=xyz&token_type=bearer&expires_in=3600 + + ``` + + + ### Refresh Token flow + + + You need to refresh your access token if you receive this error message as a + response to your request: + + + ```json + + { + "httpStatus": 401, + "code": 1014, + "codeDescription": "Problem during authentication process, check headers!", + "message": "The access token provided is expired", + "moreInfo": "https://apidocs.getresponse.com/v3/errors/1014", + "context": { + "sentToken": "b8b1e961a7f9fd4cc710d5d955e09c15a364ab71" + } + } + + ``` + + + If you are using the Authorization Code flow, you need to use the refresh + token to issue a new access token/refresh token pair by making the following + request: + + + ``` + + $ curl -u client_id:client_secret https://api.getresponse.com/v3/token \ + -d 'grant_type=refresh_token&refresh_token=170d9f64e781aaa6b3ba036083faba71b2fc4e6c' + ``` + + + *Remember to replace `client_id` and `client_secret` with your OAuth + application credentials.* + + + The response you'll get will look like this: + + + ```json + + { + "access_token": "890fdsa2f5d7b189fc4e6c4b1d170d9f591238ss", + "expires_in": 86400, + "token_type": "Bearer", + "scope": null, + "refresh_token": "170d9f64e781aaa6b3ba036083faba71b2fc4e6c" + } + + ``` + + + ### GetResponse MAX + + + There are some differences when authenticating GetResponse MAX users: + + + - the application must redirect to a page in the client's custom domain, for + example: `https://custom-domain.getresponse360.com/oauth2_authorize.html` + + - token requests have to be send to one of the GetResponse MAX APIv3 + endpoints (depending on the client's environment), + + - token requests have to include an `X-Domain` header, + + - the application has to be registered in a GetResponse MAX account within + the same environment. + + + + # CORS (AJAX requests) + + + [Cross-Origin Resource Sharing + (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) mechanism is + not supported by APIv3. It means that AJAX requests to the API will be + blocked by the browser's [same-origin + policy](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy). + Please use a server-side application to access the API. + + + + # Timezone settings + + + The default timezone in response data is **UTC**. + + + To set a different timezone, add `X-Time-Zone` header with value of [time + zone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) + ("TZ database name" column). + + + + # Pagination + + + Most of the resource collections returned by API are paginated. It means + that the response is divided into multiple pages. + + + Control the number of results on each page by using `perPage` query + parameter and change pages by using `page` query parameter. + + + By default we return only the first **100** resources per page. You can + change that by adding `perPage` parameter with a value of up to **1000**. + + + Page numbers start with **1**. + + + Paginated responses have 3 extra headers: + + * `TotalCount` – a total number of resources on all pages + + * `TotalPages` – a total number of pages + + * `CurrentPage` – current page number + + + Use the maximum `perPage` value (**1000**) if you plan to iterate over all + the pages of the response. + + + When trying to get a page that exceeds the total number of pages, API will + return an empty array (`[]`). Make sure to stop iterating when it happens. + + + + # CURLE_SSL_CACERT error + + + Solution to CURLE_SSL_CACERT error (code 60). + + + This error is related to expired CA (Certificate Authority) certificates + installed on your server (the server that you send the requests from). You + can read more about certificate verification on the [cURL project + website](https://curl.haxx.se/docs/sslcerts.html). + + + If you encounter this error while sending requests to the GetResponse APIv3, + ask your server administrator to update the CA certificates using the + [latest bundle provided by the cURL + project](https://curl.haxx.se/docs/caextract.html). + + + **Please make sure that cURL is configured to use the updated bundle.** + apiTitle: GetResponse APIv3 + endpoints: 134 + sdkMethods: 280 + schemas: 368 + parameters: 649 + contactUrl: https://app.getresponse.com/feedback.html?devzone=yes + contactEmail: getresponse-devzone@cs.getresponse.com + originalCustomRequest: + type: GET + url: https://apireference.getresponse.com/open-api.json + customRequestSpecFilename: getresponse.com.yaml + difficultyScore: 626.25 diff --git a/sdks/db/progress/get-response-progress.yaml b/sdks/db/progress/get-response-progress.yaml new file mode 100644 index 0000000000..d7efbe0a8c --- /dev/null +++ b/sdks/db/progress/get-response-progress.yaml @@ -0,0 +1,853 @@ +examples: {} +examples_2: {} +examples_3: {} +ignoreObjectsWithNoProperties: true +ignorePotentialIncorrectType: true +operationIds: + /ab-tests/subject: + get: AbTestsSubject_getList + post: AbTestsSubject_createNewTest + /ab-tests/subject/{abTestId}: + get: AbTestsSubject_getSingleById + /ab-tests/subject/{abTestId}/winner: + post: AbTestsSubject_chooseWinner + /accounts: + get: Accounts_getInformation + post: Accounts_updateAccountDetails + /accounts/badge: + get: Accounts_getCurrentStatusOfBadge + post: Accounts_toggleBadgeStatus + /accounts/billing: + get: Accounts_getBillingInformation + /accounts/blocklists: + get: Accounts_getBlocklistMasks + post: Accounts_updateBlocklist + /accounts/callbacks: + delete: Accounts_disableCallbacks + get: Accounts_getConfiguration + post: Accounts_enableCallbacksConfiguration + /accounts/industries: + get: Accounts_listIndustryTags + /accounts/login-history: + get: Accounts_getLoginHistory + /accounts/sending-limits: + get: Accounts_getSendingLimits + /accounts/timezones: + get: Accounts_getTimezonesList + /addresses: + get: Addresses_getList + post: Addresses_createNewAddress + /addresses/{addressId}: + delete: Addresses_deleteAddress + get: Addresses_getAddressById + post: Addresses_updateAddress + /autoresponders: + get: Autoresponders_getList + post: Autoresponders_createNewAutoresponder + /autoresponders/statistics: + get: Autoresponders_getAllStatistics + /autoresponders/{autoresponderId}: + delete: Autoresponders_deleteById + get: Autoresponders_getById + post: Autoresponders_updateAutoresponder + /autoresponders/{autoresponderId}/statistics: + get: Autoresponders_getStatistics + /autoresponders/{autoresponderId}/thumbnail: + get: Autoresponders_getThumbnail + /campaigns: + get: CampaignsLists_getList + post: CampaignsLists_createNewCampaign + /campaigns/statistics/balance: + get: CampaignsLists_getBalanceStatistics + /campaigns/statistics/list-size: + get: CampaignsLists_getCampaignSizeStatistics + /campaigns/statistics/locations: + get: CampaignsLists_getSubscriberLocationStatistics + /campaigns/statistics/origins: + get: CampaignsLists_getSubscriberOriginStatistics + /campaigns/statistics/removals: + get: CampaignsLists_getRemovalStatistics + /campaigns/statistics/subscriptions: + get: CampaignsLists_getSubscriptionStatistics + /campaigns/statistics/summary: + get: CampaignsLists_getStatisticsSummary + /campaigns/{campaignId}: + get: CampaignsLists_getSingleCampaign + post: CampaignsLists_updateCampaign + /campaigns/{campaignId}/blocklists: + get: CampaignsLists_getBlocklistMasks + post: CampaignsLists_updateBlocklistMasks + /campaigns/{campaignId}/contacts: + get: Contacts_getSingleCampaignContacts + /click-tracks: + get: ClickTracks_getList + /click-tracks/{clickTrackId}: + get: ClickTracks_getLinkDetailsById + /contacts: + get: Contacts_getList + post: Contacts_createNewContact + /contacts/batch: + post: Contacts_createBatchContacts + /contacts/{contactId}: + delete: Contacts_deleteById + get: Contacts_getDetailsById + post: Contacts_updateDetails + /contacts/{contactId}/activities: + get: Contacts_getListOfActivities + /contacts/{contactId}/custom-fields: + post: Contacts_upsertCustomFields + /contacts/{contactId}/tags: + post: Contacts_upsertContactTags + /custom-events: + get: CustomEvents_getList + post: CustomEvents_createEvent + /custom-events/trigger: + post: CustomEvents_triggerEvent + /custom-events/{customEventId}: + delete: CustomEvents_deleteEventById + get: CustomEvents_getById + post: CustomEvents_updateDetails + /custom-fields: + get: CustomFields_getList + post: CustomFields_createNewField + /custom-fields/{customFieldId}: + delete: CustomFields_deleteSingleCustomField + get: CustomFields_getDefinitionById + post: CustomFields_updateDefinition + /file-library/files: + get: FileLibrary_getFileList + post: FileLibrary_createNewFile + /file-library/files/{fileId}: + delete: FileLibrary_deleteFileById + get: FileLibrary_getFileById + /file-library/folders: + get: FileLibrary_listFolders + post: FileLibrary_createFolder + /file-library/folders/{folderId}: + delete: FileLibrary_deleteFolderById + /file-library/quota: + get: FileLibrary_getStorageInfo + /forms: + get: Forms_getList + /forms/{formId}: + get: Forms_getById + /forms/{formId}/variants: + get: Forms_getListOfVariants + /from-fields: + get: FromFields_getList + post: FromFields_createNewAddress + /from-fields/{fromFieldId}: + delete: FromFields_deleteAddress + get: FromFields_getSingleAddressById + /from-fields/{fromFieldId}/default: + post: FromFields_setFromAddressAsDefault + /gdpr-fields: + get: GdprFields_getList + /gdpr-fields/{gdprFieldId}: + get: GdprFields_getDetails + /imports: + get: Imports_getList + post: Imports_scheduleNewContactImport + /imports/{importId}: + get: Imports_getImportDetailsById + /landing-pages: + get: LegacyLandingPages_getList + /landing-pages/{landingPageId}: + get: LegacyLandingPages_getById + /lps: + get: LandingPages_getList + /lps/{lpsId}: + get: LandingPages_getById + /multimedia: + get: Multimedia_getImageList + post: Multimedia_uploadImage + /newsletters: + get: Newsletters_getList + post: Newsletters_enqueueNewsletter + /newsletters/send-draft: + post: Newsletters_sendDraft + /newsletters/statistics: + get: Newsletters_getStatisticsBasedOnList + /newsletters/{newsletterId}: + delete: Newsletters_deleteNewsletter + get: Newsletters_getSingleById + /newsletters/{newsletterId}/activities: + get: Newsletters_getActivities + /newsletters/{newsletterId}/cancel: + post: Newsletters_cancelSending + /newsletters/{newsletterId}/statistics: + get: Newsletters_getStatistics + /newsletters/{newsletterId}/thumbnail: + get: Newsletters_getThumbnail + /popups: + get: FormsAndPopups_getList + /popups/{popupId}: + get: FormsAndPopups_getFormOrPopupById + /predefined-fields: + get: PredefinedFields_getList + post: PredefinedFields_createField + /predefined-fields/{predefinedFieldId}: + delete: PredefinedFields_deleteField + get: PredefinedFields_getById + post: PredefinedFields_updateField + /rss-newsletters: + get: RssNewsletters_getList + post: RssNewsletters_createNewsletter + /rss-newsletters/statistics: + get: RssNewsletters_getStatistics + /rss-newsletters/{rssNewsletterId}: + delete: RssNewsletters_deleteNewsletter + get: RssNewsletters_getById + post: RssNewsletters_updateNewsletter + /rss-newsletters/{rssNewsletterId}/statistics: + get: RssNewsletters_getStatisticsById + /search-contacts: + get: SearchContacts_savedList + post: SearchContacts_createNewSearch + /search-contacts/contacts: + post: SearchContacts_usingConditions + /search-contacts/{searchContactId}: + delete: SearchContacts_deleteById + get: SearchContacts_byContactId + post: SearchContacts_updateSpecifiedContacts + /search-contacts/{searchContactId}/contacts: + get: SearchContacts_byId + /search-contacts/{searchContactId}/custom-fields: + post: SearchContacts_upsertCustomFieldsByContactId + /shops: + get: Shops_getListOfShops + post: Shops_createNewShop + /shops/{shopId}: + delete: Shops_deleteShop + get: Shops_getById + post: Shops_updatePreferences + /shops/{shopId}/carts: + get: Carts_getShopCarts + post: Carts_createNewCart + /shops/{shopId}/carts/{cartId}: + delete: Carts_deleteCart + get: Carts_getByIdInShopContext + post: Carts_updateCartProperties + /shops/{shopId}/categories: + get: Categories_list + post: Categories_createNewCategory + /shops/{shopId}/categories/{categoryId}: + delete: Categories_deleteCategory + get: Categories_getById + post: Categories_updateCategoryProperties + /shops/{shopId}/meta-fields: + get: MetaFields_getCollection + post: MetaFields_createNewMetaField + /shops/{shopId}/meta-fields/{metaFieldId}: + delete: MetaFields_delete + get: MetaFields_getById + post: MetaFields_updateProperties + /shops/{shopId}/orders: + get: Orders_getList + post: Orders_createNewOrder + /shops/{shopId}/orders/{orderId}: + delete: Orders_deleteOrder + get: Orders_getById + post: Orders_updateOrder + /shops/{shopId}/products: + get: Products_getList + post: Products_createProduct + /shops/{shopId}/products/{productId}: + delete: Products_deleteProduct + get: Products_getByShopIdAndProductId + post: Products_updateProduct + /shops/{shopId}/products/{productId}/categories: + post: Products_upsertCategories + /shops/{shopId}/products/{productId}/meta-fields: + post: Products_upsertMetaFields + /shops/{shopId}/products/{productId}/variants: + get: ProductVariants_getProductVariantsList + post: ProductVariants_createNewVariant + /shops/{shopId}/products/{productId}/variants/{variantId}: + delete: ProductVariants_deleteVariant + get: ProductVariants_getById + post: ProductVariants_updateVariantProperties + /shops/{shopId}/taxes: + get: Taxes_getList + post: Taxes_createNewTax + /shops/{shopId}/taxes/{taxId}: + delete: Taxes_deleteById + get: Taxes_getSingleById + post: Taxes_updateShopTax + /sms: + get: SmsMessages_getList + /sms-automation: + get: SmsAutomationMessages_getList + /sms/{smsId}: + get: SmsMessages_getById + /splittests: + get: AbTests_getList + /splittests/{splittestId}: + get: AbTests_getSingleAbTestById + /statistics/ecommerce/performance: + get: Ecommerce_getPerformanceStatistics + /statistics/ecommerce/revenue: + get: Ecommerce_getRevenueStatistics + /statistics/lps/{lpsId}/performance: + get: LandingPage_getPerformanceDetails + /statistics/popups/{popupId}/performance: + get: FormAndPopup_getPerformanceStatsSinglePopup + /statistics/sms/{smsId}: + get: Sms_getMessageStatistics + /statistics/wbe/{websiteId}/performance: + get: Website_getPerformanceDetails + /subscription-confirmations/body/{languageCode}: + get: SubscriptionConfirmations_getCollectionOfBodies + /subscription-confirmations/subject/{languageCode}: + get: SubscriptionConfirmations_getSubjectCollection + /suppressions: + get: Suppressions_getSuppressionLists + post: Suppressions_createNewSuppressionList + /suppressions/{suppressionId}: + delete: Suppressions_deleteById + get: Suppressions_getSuppressionListById + post: Suppressions_updateById + /tags: + get: Tags_getList + post: Tags_addNewTag + /tags/{tagId}: + delete: Tags_deleteById + get: Tags_getById + post: Tags_updateById + /tracking: + get: Tracking_javascriptCodeSnippets + /tracking/facebook-pixels: + get: Tracking_getFacebookPixels + /transactional-emails: + get: TransactionalEmails_getList + post: TransactionalEmails_sendEmail + /transactional-emails/statistics: + get: TransactionalEmails_getOverallStatistics + /transactional-emails/templates: + get: TransactionalEmailsTemplates_getList + post: TransactionalEmailsTemplates_createNewTemplate + /transactional-emails/templates/{transactionalTemplateId}: + delete: TransactionalEmailsTemplates_deleteTemplate + get: TransactionalEmailsTemplates_getById + post: TransactionalEmailsTemplates_updateTemplate + /transactional-emails/{transactionalEmailId}: + get: TransactionalEmails_getDetailsById + /webforms: + get: LegacyForms_getList + /webforms/{webformId}: + get: LegacyForms_getById + /webinars: + get: Webinars_getList + /webinars/{webinarId}: + get: Webinars_getById + /websites: + get: Websites_getList + /websites/{websiteId}: + get: Websites_getById + /workflow: + get: Workflows_listWorkflows + /workflow/{workflowId}: + get: Workflows_getById + post: Workflows_updateSingleWorkflow +operationTags: {} +renameTags: {} +requestSchemaNames: + /contacts/batch: + post: + application/json: ContactsCreateBatchContactsRequest + /transactional-emails/templates/{transactionalTemplateId}: + post: + application/json: TransactionalEmailsTemplatesUpdateTemplateRequest +responseDescriptions: {} +responseSchemaNames: + /ab-tests/subject: + get: + '200': + application/json: AbTestsSubjectGetListResponse + /accounts/industries: + get: + '200': + application/json: AccountsListIndustryTagsResponse + /accounts/login-history: + get: + '200': + application/json: AccountsGetLoginHistoryResponse + /accounts/sending-limits: + get: + '200': + application/json: AccountsGetSendingLimitsResponse + /accounts/timezones: + get: + '200': + application/json: AccountsGetTimezonesListResponse + /addresses: + get: + '200': + application/json: AddressesGetListResponse + /autoresponders/{autoresponderId}/thumbnail: + get: + '200': + image/*: AutorespondersGetThumbnailResponse + /campaigns: + get: + '200': + application/json: CampaignsListsGetListResponse + /campaigns/{campaignId}/contacts: + get: + '200': + application/json: ContactsGetSingleCampaignContactsResponse + /click-tracks: + get: + '200': + application/json: ClickTracksGetListResponse + /contacts/{contactId}/activities: + get: + '200': + application/json: ContactsGetListOfActivitiesResponse + /contacts/{contactId}/tags: + post: + '200': + application/json: ContactsUpsertContactTagsResponse + /custom-events: + get: + '200': + application/json: CustomEventsGetListResponse + /custom-fields: + get: + '200': + application/json: CustomFieldsGetListResponse + /file-library/files: + get: + '200': + application/json: FileLibraryGetFileListResponse + /file-library/folders: + get: + '200': + application/json: FileLibraryListFoldersResponse + post: + '201': + application/json: FileLibraryCreateFolderResponse + /forms: + get: + '200': + application/json: FormsGetListResponse + /forms/{formId}/variants: + get: + '200': + application/json: FormsGetListOfVariantsResponse + /from-fields: + get: + '200': + application/json: FromFieldsGetListResponse + /gdpr-fields: + get: + '200': + application/json: GdprFieldsGetListResponse + /imports: + get: + '200': + application/json: ImportsGetListResponse + /landing-pages: + get: + '200': + application/json: LegacyLandingPagesGetListResponse + /landing-pages/{landingPageId}: + get: + '200': + application/json: LegacyLandingPagesGetByIdResponse + /lps: + get: + '200': + application/json: LandingPagesGetListResponse + /multimedia: + get: + '200': + application/json: MultimediaGetImageListResponse + /newsletters: + get: + '200': + application/json: NewslettersGetListResponse + /newsletters/{newsletterId}/activities: + get: + '200': + application/json: NewslettersGetActivitiesResponse + /newsletters/{newsletterId}/thumbnail: + get: + '200': + image/*: NewslettersGetThumbnailResponse + /popups: + get: + '200': + application/json: FormsAndPopupsGetListResponse + /predefined-fields: + get: + '200': + application/json: PredefinedFieldsGetListResponse + /rss-newsletters: + get: + '200': + application/json: RssNewslettersGetListResponse + /rss-newsletters/statistics: + get: + '200': + application/json: RssNewslettersGetStatisticsResponse + /rss-newsletters/{rssNewsletterId}/statistics: + get: + '200': + application/json: RssNewslettersGetStatisticsByIdResponse + /search-contacts: + get: + '200': + application/json: SearchContactsSavedListResponse + /search-contacts/{searchContactId}/contacts: + get: + '200': + application/json: SearchContactsByIdResponse + /shops: + get: + '200': + application/json: ShopsGetListOfShopsResponse + /shops/{shopId}/carts: + get: + '200': + application/json: CartsGetShopCartsResponse + /shops/{shopId}/categories: + get: + '200': + application/json: CategoriesListResponse + /shops/{shopId}/orders: + get: + '200': + application/json: OrdersGetListResponse + /shops/{shopId}/products: + get: + '200': + application/json: ProductsGetListResponse + /shops/{shopId}/products/{productId}/categories: + post: + '200': + application/json: ProductsUpsertCategoriesResponse + /shops/{shopId}/products/{productId}/meta-fields: + post: + '200': + application/json: ProductsUpsertMetaFieldsResponse + /shops/{shopId}/products/{productId}/variants: + get: + '200': + application/json: ProductVariantsGetProductVariantsListResponse + /shops/{shopId}/taxes: + get: + '200': + application/json: TaxesGetListResponse + /splittests: + get: + '200': + application/json: AbTestsGetListResponse + /subscription-confirmations/body/{languageCode}: + get: + '200': + application/json: SubscriptionConfirmationsGetCollectionOfBodiesResponse + /subscription-confirmations/subject/{languageCode}: + get: + '200': + application/json: SubscriptionConfirmationsGetSubjectCollectionResponse + /suppressions: + get: + '200': + application/json: SuppressionsGetSuppressionListsResponse + /tags: + get: + '200': + application/json: TagsGetListResponse + /tracking: + get: + '200': + application/json: TrackingJavascriptCodeSnippetsResponse + /tracking/facebook-pixels: + get: + '200': + application/json: TrackingGetFacebookPixelsResponse + /transactional-emails: + get: + '200': + application/json: TransactionalEmailsGetListResponse + /transactional-emails/statistics: + get: + '200': + application/json: TransactionalEmailsGetOverallStatisticsResponse + /transactional-emails/templates: + get: + '200': + application/json: TransactionalEmailsTemplatesGetListResponse + /webforms: + get: + '200': + application/json: LegacyFormsGetListResponse + /webinars: + get: + '200': + application/json: WebinarsGetListResponse + /websites: + get: + '200': + application/json: WebsitesGetListResponse + /workflow: + get: + '200': + application/json: WorkflowsListWorkflowsResponse +securityParameters: + additionalFlags: + query: false + fields: + query: false + fromFieldIdToReplaceWith: + query: false + ipAddress: + query: false + messageId: + query: false + page: + query: false + perPage: + query: false + query[abTestId]: + query: false + query[activity]: + query: false + query[address1]: + query: false + query[address2]: + query: false + query[allFolders]: + query: false + query[autoreponderId]: + query: false + query[campaignId]: + query: false + query[categoryId]: + query: false + query[category]: + query: false + query[changedOn][from]: + query: false + query[changedOn][to]: + query: false + query[city]: + query: false + query[company]: + query: false + query[createdAt][from]: + query: false + query[createdAt][to]: + query: false + query[createdOn][from]: + query: false + query[createdOn][to]: + query: false + query[date][from]: + query: false + query[date][to]: + query: false + query[description]: + query: false + query[device]: + query: false + query[domain]: + query: false + query[email]: + query: false + query[externalId]: + query: false + query[firstName]: + query: false + query[folderId]: + query: false + query[groupBy]: + query: false + query[group]: + query: false + query[hasAttributes]: + query: false + query[hasLinks]: + query: false + query[isActive]: + query: false + query[isDefault]: + query: false + query[lastName]: + query: false + query[location]: + query: false + query[mask]: + query: false + query[metaFieldNames]: + query: false + query[metaFieldValues]: + query: false + query[metaTitle]: + query: false + query[modifiedOn][from]: + query: false + query[modifiedOn][to]: + query: false + query[name]: + query: false + query[newsletterId]: + query: false + query[orderDate][from]: + query: false + query[orderDate][to]: + query: false + query[origin]: + query: false + query[page]: + query: false + query[parentId]: + query: false + query[phone]: + query: false + query[processedAt][from]: + query: false + query[processedAt][to]: + query: false + query[provinceCode]: + query: false + query[province]: + query: false + query[rssNewsletterId]: + query: false + query[sendOn][from]: + query: false + query[sendOn][to]: + query: false + query[sendingStatus]: + query: false + query[sentOn][from]: + query: false + query[sentOn][to]: + query: false + query[shopId]: + query: false + query[sku]: + query: false + query[stage]: + query: false + query[status]: + query: false + query[subdomain]: + query: false + query[subject]: + query: false + query[tagId]: + query: false + query[tagged]: + query: false + query[timeFrame][from]: + query: false + query[timeFrame][to]: + query: false + query[triggerType]: + query: false + query[type]: + query: false + query[userDomain]: + query: false + query[value]: + query: false + query[variantName]: + query: false + query[vendor]: + query: false + query[zip]: + query: false + search[createdAt][from]: + query: false + search[createdAt][to]: + query: false + size: + query: false + sort[addedContacts]: + query: false + sort[campaignId]: + query: false + sort[campaignName]: + query: false + sort[changedOn]: + query: false + sort[clickRate]: + query: false + sort[clicks]: + query: false + sort[createdAt]: + query: false + sort[createdOn]: + query: false + sort[ctr]: + query: false + sort[dayOfCycle]: + query: false + sort[delivered]: + query: false + sort[domain]: + query: false + sort[email]: + query: false + sort[finishedOn]: + query: false + sort[group]: + query: false + sort[invalidContacts]: + query: false + sort[leads]: + query: false + sort[metaTitle]: + query: false + sort[modifiedOn]: + query: false + sort[name]: + query: false + sort[openRate]: + query: false + sort[pageViews]: + query: false + sort[sendOn]: + query: false + sort[sendingStatus]: + query: false + sort[sent]: + query: false + sort[size]: + query: false + sort[stage]: + query: false + sort[startsOn]: + query: false + sort[status]: + query: false + sort[subject]: + query: false + sort[subscribed]: + query: false + sort[subscriptionRate]: + query: false + sort[totalDelivered]: + query: false + sort[uniqueVisitors]: + query: false + sort[updatedAt]: + query: false + sort[updatedContacts]: + query: false + sort[uploadedContacts]: + query: false + sort[views]: + query: false + sort[visitors]: + query: false + sort[visits]: + query: false + stats[from]: + query: false + stats[to]: + query: false +validServerUrls: {} diff --git a/sdks/db/published/from-custom-request_box.com.json b/sdks/db/published/from-custom-request_box.com.json index 1058b3b319..218f4a681d 100644 --- a/sdks/db/published/from-custom-request_box.com.json +++ b/sdks/db/published/from-custom-request_box.com.json @@ -409,11 +409,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?fields=metadata.enterprise_12345.contractTemplate`.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "ifNoneMatch", @@ -488,11 +484,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "name", @@ -549,11 +541,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "ifMatch", @@ -566,9 +554,7 @@ "name": "tags", "schema": "array", "description": "", - "example": [ - "approved" - ] + "example": ["approved"] }, { "name": "description", @@ -739,11 +725,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "contentMd5", @@ -835,11 +817,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "contentMd5", @@ -1222,11 +1200,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "version", @@ -1380,11 +1354,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "limit", @@ -1432,11 +1402,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "limit", @@ -1555,11 +1521,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -1597,11 +1559,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "limit", @@ -1691,11 +1649,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "fileVersionId", @@ -1776,11 +1730,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "id", @@ -2740,11 +2690,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?fields=metadata.enterprise_12345.contractTemplate`.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "ifNoneMatch", @@ -2837,11 +2783,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "name", @@ -2898,11 +2840,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "ifMatch", @@ -2915,9 +2853,7 @@ "name": "tags", "schema": "array", "description": "", - "example": [ - "approved" - ] + "example": ["approved"] }, { "name": "description", @@ -3031,11 +2967,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?fields=metadata.enterprise_12345.contractTemplate`.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "usemarker", @@ -3124,11 +3056,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "name", @@ -3204,11 +3132,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "name", @@ -3279,11 +3203,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -3348,11 +3268,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -3784,11 +3700,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "limit", @@ -4907,11 +4819,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -4945,11 +4853,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "message", @@ -4982,11 +4886,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "message", @@ -5067,11 +4967,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -5168,11 +5064,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "offset", @@ -5214,11 +5106,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "notify", @@ -5311,84 +5199,56 @@ "schema": "array", "required": false, "description": "Limits the search results to any files that match any of the provided\nfile extensions. This list is a comma-separated list of file extensions\nwithout the dots.", - "example": [ - "pdf", - "png", - "gif" - ] + "example": ["pdf", "png", "gif"] }, { "name": "createdAtRange", "schema": "array", "required": false, "description": "Limits the search results to any items created within\na given date range.\n\nDate ranges are defined as comma separated RFC3339\ntimestamps.\n\nIf the the start date is omitted (`,2014-05-17T13:35:01-07:00`)\nanything created before the end date will be returned.\n\nIf the end date is omitted (`2014-05-15T13:35:01-07:00,`) the\ncurrent date will be used as the end date instead.", - "example": [ - "2014-05-15T13:35:01-07:00", - "2014-05-17T13:35:01-07:00" - ] + "example": ["2014-05-15T13:35:01-07:00", "2014-05-17T13:35:01-07:00"] }, { "name": "updatedAtRange", "schema": "array", "required": false, "description": "Limits the search results to any items updated within\na given date range.\n\nDate ranges are defined as comma separated RFC3339\ntimestamps.\n\nIf the start date is omitted (`,2014-05-17T13:35:01-07:00`)\nanything updated before the end date will be returned.\n\nIf the end date is omitted (`2014-05-15T13:35:01-07:00,`) the\ncurrent date will be used as the end date instead.", - "example": [ - "2014-05-15T13:35:01-07:00", - "2014-05-17T13:35:01-07:00" - ] + "example": ["2014-05-15T13:35:01-07:00", "2014-05-17T13:35:01-07:00"] }, { "name": "sizeRange", "schema": "array", "required": false, "description": "Limits the search results to any items with a size within\na given file size range. This applied to files and folders.\n\nSize ranges are defined as comma separated list of a lower\nand upper byte size limit (https://developer.box.com/reference/.\n\nThe upper and lower bound can be omitted to create open ranges.", - "example": [ - 1000000, - 5000000 - ] + "example": [1000000, 5000000] }, { "name": "ownerUserIds", "schema": "array", "required": false, "description": "Limits the search results to any items that are owned\nby the given list of owners, defined as a list of comma separated\nuser IDs.\n\nThe items still need to be owned or shared with\nthe currently authenticated user for them to show up in the search\nresults. If the user does not have access to any files owned by any of\nthe users an empty result set will be returned.\n\nTo search across an entire enterprise, we recommend using the\n`enterprise_content` scope parameter which can be requested with our\nsupport team.", - "example": [ - "123422", - "23532", - "3241212" - ] + "example": ["123422", "23532", "3241212"] }, { "name": "recentUpdaterUserIds", "schema": "array", "required": false, "description": "Limits the search results to any items that have been updated\nby the given list of users, defined as a list of comma separated\nuser IDs.\n\nThe items still need to be owned or shared with\nthe currently authenticated user for them to show up in the search\nresults. If the user does not have access to any files owned by any of\nthe users an empty result set will be returned.\n\nThis feature only searches back to the last 10 versions of an item.", - "example": [ - "123422", - "23532", - "3241212" - ] + "example": ["123422", "23532", "3241212"] }, { "name": "ancestorFolderIds", "schema": "array", "required": false, "description": "Limits the search results to items within the given\nlist of folders, defined as a comma separated lists\nof folder IDs.\n\nSearch results will also include items within any subfolders\nof those ancestor folders.\n\nThe folders still need to be owned or shared with\nthe currently authenticated user. If the folder is not accessible by this\nuser, or it does not exist, a `HTTP 404` error code will be returned\ninstead.\n\nTo search across an entire enterprise, we recommend using the\n`enterprise_content` scope parameter which can be requested with our\nsupport team.", - "example": [ - "4535234", - "234123235", - "2654345" - ] + "example": ["4535234", "234123235", "2654345"] }, { "name": "contentTypes", "schema": "array", "required": false, "description": "Limits the search results to any items that match the search query\nfor a specific part of the file, for example the file description.\n\nContent types are defined as a comma separated lists\nof Box recognized content types. The allowed content types are as follows.\n\n* `name` - The name of the item, as defined by its `name` field.\n* `description` - The description of the item, as defined by its\n `description` field.\n* `file_content` - The actual content of the file.\n* `comments` - The content of any of the comments on a file or\n folder.\n* `tags` - Any tags that are applied to an item, as defined by its\n `tags` field.", - "example": [ - "name", - "description" - ] + "example": ["name", "description"] }, { "name": "type", @@ -5457,11 +5317,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "offset", @@ -5476,21 +5332,14 @@ "schema": "array", "required": false, "description": "Limits the search results to items that were deleted by the given\nlist of users, defined as a list of comma separated user IDs.\n\nThe `trash_content` parameter needs to be set to `trashed_only`.\n\nIf searching in trash is not performed, an empty result set\nis returned. The items need to be owned or shared with\nthe currently authenticated user for them to show up in the search\nresults.\n\nIf the user does not have access to any files owned by\nany of the users, an empty result set is returned.\n\nData available from 2023-02-01 onwards.", - "example": [ - "123422", - "23532", - "3241212" - ] + "example": ["123422", "23532", "3241212"] }, { "name": "deletedAtRange", "schema": "array", "required": false, "description": "Limits the search results to any items deleted within a given\ndate range.\n\nDate ranges are defined as comma separated RFC3339 timestamps.\n\nIf the the start date is omitted (`2014-05-17T13:35:01-07:00`),\nanything deleted before the end date will be returned.\n\nIf the end date is omitted (`2014-05-15T13:35:01-07:00`),\nthe current date will be used as the end date instead.\n\nThe `trash_content` parameter needs to be set to `trashed_only`.\n\nIf searching in trash is not performed, then an empty result\nis returned.\n\nData available from 2023-02-01 onwards.", - "example": [ - "2014-05-15T13:35:01-07:00", - "2014-05-17T13:35:01-07:00" - ] + "example": ["2014-05-15T13:35:01-07:00", "2014-05-17T13:35:01-07:00"] } ], "responses": [ @@ -5918,11 +5767,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "boxapi", @@ -6199,11 +6044,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "boxapi", @@ -6588,11 +6429,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "name", @@ -6735,11 +6572,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -6777,11 +6610,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "boxapi", @@ -7072,11 +6901,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "offset", @@ -7132,11 +6957,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "name", @@ -7288,11 +7109,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -7319,20 +7136,14 @@ "schema": "array", "required": true, "description": "", - "example": [ - "123456", - "456789" - ] + "example": ["123456", "456789"] }, { "name": "user_logins", "schema": "array", "required": true, "description": "", - "example": [ - "user@sample.com", - "user2@sample.com" - ] + "example": ["user@sample.com", "user2@sample.com"] } ], "responses": [ @@ -7429,11 +7240,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -7467,11 +7274,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "enterprise", @@ -7749,11 +7552,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "notify", @@ -7934,11 +7733,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "enterprise", @@ -7984,11 +7779,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -8022,11 +7813,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "limit", @@ -8068,11 +7855,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "description", @@ -8145,10 +7928,7 @@ "schema": "array", "required": true, "description": "", - "example": [ - "123456", - "456789" - ] + "example": ["123456", "456789"] } ], "responses": [ @@ -8233,11 +8013,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -8271,11 +8047,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "description", @@ -8426,11 +8198,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "user", @@ -8523,11 +8291,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -8561,11 +8325,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "role", @@ -8657,9 +8417,7 @@ "schema": "array", "required": true, "description": "", - "example": [ - "FILE.UPLOADED" - ] + "example": ["FILE.UPLOADED"] } ], "responses": [ @@ -8789,9 +8547,7 @@ "name": "triggers", "schema": "array", "description": "", - "example": [ - "FILE.UPLOADED" - ] + "example": ["FILE.UPLOADED"] } ], "responses": [ @@ -8919,9 +8675,7 @@ "name": "eventType", "schema": "array", "description": "A comma-separated list of events to filter by. This can only be used when\nrequesting the events with a `stream_type` of `admin_logs` or\n`adming_logs_streaming`. For any other `stream_type` this value will be\nignored.", - "example": [ - "ACCESS_GRANTED" - ] + "example": ["ACCESS_GRANTED"] }, { "name": "createdAfter", @@ -8980,11 +8734,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "offset", @@ -9033,11 +8783,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "offset", @@ -9079,11 +8825,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "limit", @@ -9145,11 +8887,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "limit", @@ -9330,11 +9068,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -9467,11 +9201,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "marker", @@ -9616,11 +9346,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -9744,11 +9470,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "marker", @@ -9988,11 +9710,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -10127,11 +9845,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -10255,11 +9969,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] } ], "responses": [ @@ -11718,11 +11428,7 @@ "schema": "array", "required": false, "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", - "example": [ - "id", - "type", - "name" - ] + "example": ["id", "type", "name"] }, { "name": "marker", @@ -12603,8 +12309,8 @@ "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/box/imagePreview.jpg", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/box/favicon.png", "clientNameCamelCase": "box", - "lastUpdated": "2024-03-28T21:38:28.766Z", + "lastUpdated": "2024-03-28T21:39:50.212Z", "typescriptSdkUsageCode": "import { Box } from 'box-typescript-sdk';\n\nconst box = new Box({\n clientId: \"CLIENT_ID\",\n clientSecret: \"CLIENT_SECRET\",\n redirectUri: \"REDIRECT_URI\"\n})", "typescriptSdkFirstRequestCode": "// Authorize user\nconst authorizeResponse = box.authorization.authorize({\n responseType: \"code\"\n clientId: \"ly1nj6n11vionaie65emwzk575hnnmrk\"\n redirectUri: \"http://example.com/auth/callback\"\n state: \"my_state\"\n scope: \"admin_readwrite\"\n})", "fixedSpecFileName": "box-fixed-spec.yaml" -} \ No newline at end of file +} diff --git a/sdks/db/published/from-custom-request_customer.io_DatePipelines.json b/sdks/db/published/from-custom-request_customer.io_DatePipelines.json index 3790ac5b22..780acf94ee 100644 --- a/sdks/db/published/from-custom-request_customer.io_DatePipelines.json +++ b/sdks/db/published/from-custom-request_customer.io_DatePipelines.json @@ -28,11 +28,7 @@ "apiStatusUrls": "inherit", "homepage": "customer.io/", "developerDocumentation": "customer.io/docs/api/cdp/", - "categories": [ - "marketing", - "big_data_analytics", - "customer_data_platform" - ], + "categories": ["marketing", "big_data_analytics", "customer_data_platform"], "category": "Marketing Automation", "methods": [ { @@ -182,15 +178,15 @@ ] } ], - "repositoryDescription": "Customer.io is a versatile marketing automation tool that uses real-time data to deliver personalized messages across web and mobile products, including event reminders, onboarding emails, newsletters, and more. Automate messaging, create newsletters, and connect with other apps to drive user behavior.", + "repositoryDescription": "Customer.io is a versatile marketing automation tool that uses real-time data to send relevant messages across web and mobile products, ensuring personalized and timely communication through automation and powerful segmentation. Customer.io's {language} SDK for Data Pipelines API generated by Konfig (https://konfigthis.com/).", "logo": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/data-pipelines/logo.png", "openApiRaw": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/data-pipelines/openapi.yaml", "openApiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/data-pipelines/openapi.yaml", "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/data-pipelines/imagePreview.png", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/data-pipelines/favicon.png", "clientNameCamelCase": "customerIoDataPipelines", - "lastUpdated": "2024-03-28T21:38:28.766Z", + "lastUpdated": "2024-03-28T21:39:50.212Z", "typescriptSdkUsageCode": "import { CustomerIoDataPipelines } from 'customer-io-data-pipelines-typescript-sdk';\n\nconst customerIoDataPipelines = new CustomerIoDataPipelines({\n /*\n * The Data Pipelines API uses a basic authentication scheme with your API key. Because basic authorization typically expects a username and password combination, you'll use the API Key as the username and leave the password blank—base64 encoding your credentials in the format `API_key:`. \n * \n */\n username: \"USERNAME\",\n password: \"PASSWORD\"\n})", "typescriptSdkFirstRequestCode": "// Identify\nconst personTraitsAssignmentResponse = customerIoDataPipelines.identification.personTraitsAssignment()", "fixedSpecFileName": "customer-io-data-pipelines-fixed-spec.yaml" -} \ No newline at end of file +} diff --git a/sdks/db/published/from-custom-request_customer.io_JourneysApp.json b/sdks/db/published/from-custom-request_customer.io_JourneysApp.json index 84e2d95f43..b130fcd0a3 100644 --- a/sdks/db/published/from-custom-request_customer.io_JourneysApp.json +++ b/sdks/db/published/from-custom-request_customer.io_JourneysApp.json @@ -28,11 +28,7 @@ "apiStatusUrls": "inherit", "homepage": "customer.io", "developerDocumentation": "customer.io/docs/api/app/", - "categories": [ - "messaging", - "email", - "marketing" - ], + "categories": ["messaging", "email", "marketing"], "category": "Marketing Automation", "methods": [ { @@ -2520,10 +2516,7 @@ "schema": "array", "required": true, "description": "", - "example": [ - "email_failed", - "webhook_failed" - ] + "example": ["email_failed", "webhook_failed"] } ], "responses": [ @@ -2643,10 +2636,7 @@ "schema": "array", "required": true, "description": "", - "example": [ - "email_failed", - "webhook_failed" - ] + "example": ["email_failed", "webhook_failed"] } ], "responses": [ @@ -3435,15 +3425,15 @@ ] } ], - "repositoryDescription": "Customer.io is a dynamic tool for personalized marketing automation. Utilize real-time data to send targeted messages across web and mobile products, improving user experiences and engagement. Automate messaging and connect with other apps for effective user behavior management.", + "repositoryDescription": "Customer.io is a versatile marketing automation tool that uses real-time data to deliver personalized messages across web and mobile products, enabling automated product messaging, newsletters, and behavioral messages. Connect with other apps for powerful segmentation and automation.", "logo": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-app/logo.png", "openApiRaw": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-app/openapi.yaml", "openApiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/journeys-app/openapi.yaml", "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-app/imagePreview.png", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-app/favicon.png", "clientNameCamelCase": "customerIoJourneysApp", - "lastUpdated": "2024-03-28T21:38:28.766Z", + "lastUpdated": "2024-03-28T21:39:50.212Z", "typescriptSdkUsageCode": "import { CustomerIoJourneysApp } from 'customer-io-journeys-app-typescript-sdk';\n\nconst customerIoJourneysApp = new CustomerIoJourneysApp({\n /*\n * The App API uses a bearer authentication scheme.\n * \n * 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](https://customer.io/docs/api/app/).\n * \n */\n bearerAuth: \"BEARER_AUTH\"\n})", "typescriptSdkFirstRequestCode": "// Trigger a broadcast\nconst triggerBroadcastResponse = customerIoJourneysApp.sendMessages.triggerBroadcast()", "fixedSpecFileName": "customer-io-journeys-app-fixed-spec.yaml" -} \ No newline at end of file +} diff --git a/sdks/db/published/from-custom-request_customer.io_JourneysTrack.json b/sdks/db/published/from-custom-request_customer.io_JourneysTrack.json index 673d4463a1..b1e22bface 100644 --- a/sdks/db/published/from-custom-request_customer.io_JourneysTrack.json +++ b/sdks/db/published/from-custom-request_customer.io_JourneysTrack.json @@ -28,11 +28,7 @@ "apiStatusUrls": "inherit", "homepage": "customer.io", "developerDocumentation": "customer.io/docs/api/track/", - "categories": [ - "automation", - "marketing", - "messaging" - ], + "categories": ["automation", "marketing", "messaging"], "category": "Marketing Automation", "methods": [ { @@ -541,15 +537,15 @@ ] } ], - "repositoryDescription": "Customer.io offers a versatile marketing automation tool for personalized messaging based on user behavior. Automate product messaging, newsletters, and more to connect with users effectively and save time. Customer.io's {language} SDK for Journeys Track API generated by Konfig (https://konfigthis.com/).", + "repositoryDescription": "Customer.io is a versatile marketing automation tool using real-time data to deliver the right message at the right time. Automate product messaging, create newsletters, and connect with other apps to drive user behavior efficiently. Customer.io's {language} SDK for Journeys Track API generated by Konfig (https://konfigthis.com/).", "logo": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-track/logo.png", "openApiRaw": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-track/openapi.yaml", "openApiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/customer-io/journeys-track/openapi.yaml", "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-track/imagePreview.png", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/customer-io/journeys-track/favicon.png", "clientNameCamelCase": "customerIoJourneysTrack", - "lastUpdated": "2024-03-28T21:38:28.766Z", + "lastUpdated": "2024-03-28T21:39:50.212Z", "typescriptSdkUsageCode": "import { CustomerIoJourneysTrack } from 'customer-io-journeys-track-typescript-sdk';\n\nconst customerIoJourneysTrack = new CustomerIoJourneysTrack({\n /*\n * The Track API uses a basic authentication scheme. Your credentials are your **Site ID** and your **API key**, **Base-64 encoded** in the format `site_id:api_key`.\n * \n * You can find your Site ID and API key on the [Track API Keys page](https://fly.customer.io/settings/api_credentials).\n * \n */\n username: \"USERNAME\",\n password: \"PASSWORD\"\n})", "typescriptSdkFirstRequestCode": "// Find your account region\nconst findAccountRegionResponse = customerIoJourneysTrack.trackRegion.findAccountRegion()", "fixedSpecFileName": "customer-io-journeys-track-fixed-spec.yaml" -} \ No newline at end of file +} diff --git a/sdks/db/published/from-custom-request_digitalocean.com.json b/sdks/db/published/from-custom-request_digitalocean.com.json index 0929f26b75..23fa51cf48 100644 --- a/sdks/db/published/from-custom-request_digitalocean.com.json +++ b/sdks/db/published/from-custom-request_digitalocean.com.json @@ -91,10 +91,7 @@ "schema": "array", "required": true, "description": "", - "example": [ - "kube-state-metrics", - "loki" - ], + "example": ["kube-state-metrics", "loki"], "default": [] }, { @@ -1513,9 +1510,7 @@ "name": "emails", "schema": "array", "description": "", - "example": [ - "sammy@digitalocean.com" - ] + "example": ["sammy@digitalocean.com"] }, { "name": "slack_webhooks", @@ -2146,10 +2141,7 @@ "schema": "array", "required": true, "description": "", - "example": [ - "path/to/image.png", - "path/to/css/*" - ] + "example": ["path/to/image.png", "path/to/css/*"] } ], "responses": [ @@ -3048,10 +3040,7 @@ "name": "ignore_dbs", "schema": "array", "description": "", - "example": [ - "db0", - "db1" - ], + "example": ["db0", "db1"], "default": [] } ], @@ -3517,9 +3506,7 @@ "schema": "array", "required": false, "description": "", - "example": [ - "production" - ] + "example": ["production"] }, { "name": "id", @@ -6598,41 +6585,31 @@ "name": "floating_ips", "schema": "array", "description": "", - "example": [ - "6186916" - ] + "example": ["6186916"] }, { "name": "reserved_ips", "schema": "array", "description": "", - "example": [ - "6186916" - ] + "example": ["6186916"] }, { "name": "snapshots", "schema": "array", "description": "", - "example": [ - "61486916" - ] + "example": ["61486916"] }, { "name": "volumes", "schema": "array", "description": "", - "example": [ - "ba49449a-7435-11ea-b89e-0a58ac14480f" - ] + "example": ["ba49449a-7435-11ea-b89e-0a58ac14480f"] }, { "name": "volume_snapshots", "schema": "array", "description": "", - "example": [ - "edb0478d-7436-11ea-86e6-0a58ac144b91" - ] + "example": ["edb0478d-7436-11ea-86e6-0a58ac144b91"] } ], "responses": [ @@ -7038,9 +7015,7 @@ "schema": "array", "required": true, "description": "", - "example": [ - 49696269 - ] + "example": [49696269] } ], "responses": [ @@ -7094,9 +7069,7 @@ "schema": "array", "required": true, "description": "", - "example": [ - 49696269 - ] + "example": [49696269] } ], "responses": [ @@ -8981,25 +8954,19 @@ "name": "load_balancers", "schema": "array", "description": "", - "example": [ - "4de7ac8b-495b-4884-9a69-1050c6793cd6" - ] + "example": ["4de7ac8b-495b-4884-9a69-1050c6793cd6"] }, { "name": "volumes", "schema": "array", "description": "", - "example": [ - "ba49449a-7435-11ea-b89e-0a58ac14480f" - ] + "example": ["ba49449a-7435-11ea-b89e-0a58ac14480f"] }, { "name": "volume_snapshots", "schema": "array", "description": "", - "example": [ - "edb0478d-7436-11ea-86e6-0a58ac144b91" - ] + "example": ["edb0478d-7436-11ea-86e6-0a58ac144b91"] } ], "responses": [ @@ -9713,9 +9680,7 @@ "name": "nodes", "schema": "array", "description": "", - "example": [ - "d8db5e1a-6103-43b5-a7b3-8a948210a9fc" - ] + "example": ["d8db5e1a-6103-43b5-a7b3-8a948210a9fc"] } ], "responses": [ @@ -9892,36 +9857,25 @@ "name": "include_groups", "schema": "array", "description": "", - "example": [ - "basic", - "doks", - "security" - ] + "example": ["basic", "doks", "security"] }, { "name": "include_checks", "schema": "array", "description": "", - "example": [ - "bare-pods", - "resource-requirements" - ] + "example": ["bare-pods", "resource-requirements"] }, { "name": "exclude_groups", "schema": "array", "description": "", - "example": [ - "workload-health" - ] + "example": ["workload-health"] }, { "name": "exclude_checks", "schema": "array", "description": "", - "example": [ - "default-namespace" - ] + "example": ["default-namespace"] } ], "responses": [ @@ -10261,10 +10215,7 @@ "schema": "array", "required": true, "description": "", - "example": [ - 3164444, - 3164445 - ] + "example": [3164444, 3164445] } ], "responses": [ @@ -10314,10 +10265,7 @@ "schema": "array", "required": true, "description": "", - "example": [ - 3164444, - 3164445 - ] + "example": [3164444, 3164445] } ], "responses": [ @@ -10506,9 +10454,7 @@ "schema": "array", "required": true, "description": "", - "example": [ - "droplet_tag" - ] + "example": ["droplet_tag"] }, { "name": "description", @@ -10542,9 +10488,7 @@ "schema": "array", "required": true, "description": "", - "example": [ - "192018292" - ] + "example": ["192018292"] }, { "name": "type", @@ -10697,9 +10641,7 @@ "schema": "array", "required": true, "description": "", - "example": [ - "droplet_tag" - ] + "example": ["droplet_tag"] }, { "name": "description", @@ -10733,9 +10675,7 @@ "schema": "array", "required": true, "description": "", - "example": [ - "192018292" - ] + "example": ["192018292"] }, { "name": "type", @@ -12056,9 +11996,7 @@ "name": "resources", "schema": "array", "description": "", - "example": [ - "do:droplet:13457723" - ] + "example": ["do:droplet:13457723"] } ], "responses": [ @@ -12135,9 +12073,7 @@ "name": "resources", "schema": "array", "description": "", - "example": [ - "do:droplet:13457723" - ] + "example": ["do:droplet:13457723"] } ], "responses": [ @@ -14599,10 +14535,7 @@ "schema": "array", "required": false, "description": "", - "example": [ - "base-image", - "prod" - ] + "example": ["base-image", "prod"] }, { "name": "name", @@ -15046,10 +14979,7 @@ "name": "regions", "schema": "array", "description": "", - "example": [ - "us_east", - "eu_west" - ] + "example": ["us_east", "eu_west"] }, { "name": "enabled", @@ -15205,10 +15135,7 @@ "name": "regions", "schema": "array", "description": "", - "example": [ - "us_east", - "eu_west" - ] + "example": ["us_east", "eu_west"] }, { "name": "enabled", @@ -15583,8 +15510,8 @@ "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/digitalocean/imagePreview.png", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/digitalocean/favicon.png", "clientNameCamelCase": "digitalOcean", - "lastUpdated": "2024-03-28T21:38:28.766Z", + "lastUpdated": "2024-03-28T21:39:50.212Z", "typescriptSdkUsageCode": "import { DigitalOcean } from 'digital-ocean-typescript-sdk';\n\nconst digitalOcean = new DigitalOcean({\n /*\n * ## OAuth Authentication\n * \n * In order to interact with the DigitalOcean API, you or your application must\n * authenticate.\n * \n * The DigitalOcean API handles this through OAuth, an open standard for\n * authorization. OAuth allows you to delegate access to your account in full\n * or in read-only mode.\n * \n * You can generate an OAuth token by visiting the [Apps & API](https://cloud.digitalocean.com/account/api/tokens)\n * section of the DigitalOcean control panel for your account.\n * \n * An OAuth token functions as a complete authentication request. In effect, it\n * acts as a substitute for a username and password pair.\n * \n * Because of this, it is absolutely **essential** that you keep your OAuth\n * tokens secure. In fact, upon generation, the web interface will only display\n * each token a single time in order to prevent the token from being compromised.\n * \n * DigitalOcean access tokens begin with an identifiable prefix in order to\n * distinguish them from other similar tokens.\n * \n * - `dop_v1_` for personal access tokens generated in the control panel\n * - `doo_v1_` for tokens generated by applications using [the OAuth flow](https://docs.digitalocean.com/reference/api/oauth-api/)\n * - `dor_v1_` for OAuth refresh tokens\n * \n * ### How to Authenticate with OAuth\n * \n * In order to make an authenticated request, include a bearer-type\n * `Authorization` header containing your OAuth token. All requests must be\n * made over HTTPS.\n * \n * ### Authenticate with a Bearer Authorization Header\n * \n * ```\n * curl -X $HTTP_METHOD -H \"Authorization: Bearer $DIGITALOCEAN_TOKEN\" \"https://api.digitalocean.com/v2/$OBJECT\"\n * ```\n * \n */\n bearerAuth: \"BEARER_AUTH\"\n})", "typescriptSdkFirstRequestCode": "// List 1-Click Applications\nconst listResponse = digitalOcean.1ClickApplications.list({\n type: \"kubernetes\"\n})", "fixedSpecFileName": "digital-ocean-fixed-spec.yaml" -} \ No newline at end of file +} diff --git a/sdks/db/published/from-custom-request_getresponse.com.json b/sdks/db/published/from-custom-request_getresponse.com.json new file mode 100644 index 0000000000..5813e4d8cc --- /dev/null +++ b/sdks/db/published/from-custom-request_getresponse.com.json @@ -0,0 +1,11613 @@ +{ + "securitySchemes": { + "api-key": { + "type": "apiKey", + "description": "Header value must be prefixed with api-key", + "name": "X-Auth-Token", + "in": "header" + }, + "oauth2": { + "type": "oauth2", + "flows": { + "implicit": { + "authorizationUrl": "https://app.getresponse.com/oauth2_authorize.html", + "scopes": { + "all": "all data access" + } + }, + "authorizationCode": { + "authorizationUrl": "https://app.getresponse.com/oauth2_authorize.html", + "tokenUrl": "https://api.getresponse.com/v3/token", + "scopes": { + "all": "all data access" + } + }, + "clientCredentials": { + "tokenUrl": "https://api.getresponse.com/v3/token", + "scopes": { + "all": "all data access" + } + } + } + } + }, + "apiBaseUrl": "https://api.getresponse.com/v3", + "apiVersion": "3.2024-03-04T09:53:07+0000", + "apiDescription": "\n\n# Limits and throttling\n\nGetResponse API calls are subject to throttling to ensure a high level of service for all users.\n\n## Time frame\n\nTime frame is a period of time for which we calculate the API call limits. The limits reset in every time frame.\n\nThe time frame duration is **10 minutes**.\n\n## Basic rate limits\n\nEach user is allowed to make **30,000 API calls per time frame** (10 minutes) and **80 API calls per second**.\n\n## Parallel requests limit\n\nIt is possible to send up to **10 simultaneous requests**.\n\n## Headers\n\nEvery API response includes a few additional headers:\n\n* `X-RateLimit-Limit` – the total number of requests available per time frame\n* `X-RateLimit-Remaining` – the number of requests left in the current time frame\n* `X-RateLimit-Reset` – seconds left in the current time frame\n\n## Errors\n\nThe **429 Too Many Requests** HTTP response code indicates that the limit has been reached. The error response includes `currentLimit` and `timeToReset` fields in the context section, with the total number of requests available per time frame and seconds left in the current time frame respectively.\n\n## Reaching the limit\n\nWhen you reach the limit, you need to wait for the time specified in `timeToReset` field or `X-RateLimit-Reset` header before making another request.\n\n# Authentication\n\nAPI can be accessed by authenticated users only. This means that every request must be signed with your credentials. We offer two methods of authentication: API Key and OAuth 2.0. API key is our primary method and should be used in most cases. GetResponse MAX clients have to send an `X-Domain` header in addition to the API key. Supported OAuth 2.0 flows are: Authorization Code, Client Credentials, Implicit, and Refresh Token.\n\n## API key\n\nFollow these steps to send an authentication request:\n\n* Find your unique and secret API key in the panel: [https://app.getresponse.com/api](https://app.getresponse.com/api)\n* Add a custom `X-Auth-Token` header to all your requests. For example, if your API key is `jfgs8jh4ksg93ban9Dfgh8`, the header will look like this:\n\n```\nX-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8\n```\n\n**For security reasons, unused API keys expire after 90 days. When that happens, you’ll need to generate a new key to use our API.**\n\n### Example authenticated request\n\n```\n$ curl -H \"X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8\" https://api.getresponse.com/v3/accounts\n```\n\n## OAuth 2.0\n\nTo use OAuth 2.0 authentication, you need to get an \"Access Token\". For more information on how to obtain a token, head to our dedicated page: [OAuth 2.0](/#section/Authentication/Using-OAuth-2.0)\n\nTo authenticate a request using an Access Token, set the value of `Authorization` header to \"Bearer\" followed by the Access Token.\n\n### Example\n\nIf the Access Token is `jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8`\n\n```\nAuthorization: Bearer jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8\n```\n\n## GetResponse MAX\n\nGetResponse MAX customers need to take an extra step to authenticate the request. All requests have to be send with an `X-Domain` header that contains the client's domain. For example:\n\n```\nX-Domain: example.com\n```\n\nPlease note that the header must contain only the domain name, without the protocol identifier (`http://` or `https://`).\n\n## Using OAuth 2.0\n\n### Registering your own application\n\nIf you want to use an OAuth flow to authorize your application, first [register your application](https://app.getresponse.com/authorizations)\n\nYou need to provide a name, short description, and redirect URL.\n\n### Choosing grant flow\n\nOnce your application is registered, you can click on it to see your `client_id` and `client_secret`. They're basically a login and password for your application's access, so be sure not to share them with anyone.\n\nNext, decide which authentication flow (grant type) you want to use. Here are your options:\n\n- choose the **Authorization Code** flow if your application is server-based (you have a server with its own domain and server-side code),\n- choose the **Implicit** flow if your application is based mostly on JavaScript or client-side code,\n- choose the **Client Credential** flow if you want to test your application or access your GetResponse account,\n- implement the **Refresh Token** flow to handle token expiration if you use the Authorization Code flow.\n\n### Authorization Code flow\n\nFirst, your application must redirect a resource owner to the following URL:\n\n```\nhttps://app.getresponse.com/oauth2_authorize.html?response_type=code&client_id=_your_client_id_&state=xyz\n```\n\nThe `state` parameter is there for security reasons and should be a random string. When the resource owner grants your application access to the resource, we will redirect the browser to the `redirect URL` you specified in the application settings and attach the same state as the parameter. Comparing the state parameter value ensures that the redirect was initiated by our system. The code parameter is an authorization code that you can exchange for an access token within 10 minutes, after which time it expires.\n\n#### Example redirect with authorization code\n\n```\nhttps://myredirecturi.com/cb?code=ed17c498bfe343175cd7684c5b09979f2875b25c&state=xyz\n```\n\n#### Exchanging authorization code for the access token\n\nHere's an example request to exchange authorization code for the access token:\n\n```\n$ curl -u client_id:client_secret https://api.getresponse.com/v3/token \\\n -d 'grant_type=authorization_code&code=ed17c498bfe343175cd7684c5b09979f2875b25c'\n```\n\n*Remember to replace `client_id` and `client_secret` with your OAuth application credentials.*\n\n##### Example response\n\n```json\n{\n \"access_token\": \"03807cb390319329bdf6c777d4dfae9c0d3b3c35\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\",\n \"scope\": null,\n \"refresh_token\": \"170d9f64e781aaa6b3ba036083faba71b2fc4e6c\"\n}\n```\n\n### Client Credentials flow\n\nThis flow is suitable for development, when you need to quickly access API to create some functionality. You can get the access token with a single request:\n\n#### Request\n\n```\n$ curl -u client_id:client_secret https://api.getresponse.com/v3/token \\\n -d 'grant_type=client_credentials'\n```\n\n*Remember to replace `client_id` and `client_secret` with your OAuth application credentials.*\n\n#### Response\n\n```json\n{\n \"access_token\": \"e2222af2851a912470ec33c9b4de1ea3a304b7d7\",\n \"expires_in\": 86400,\n \"token_type\": \"Bearer\",\n \"scope\": null\n}\n```\n\nYou can also go to https://app.getresponse.com/manage_api.html, click the action button for your application, and select \"generate credentials\". This will open a popup with a generated access token. You can then use the access token to authenticate your requests, for example:\n\n```\n$ curl -H \"Authorization: Bearer e2222af2851a912470ec33c9b4de1ea3a304b7d7\" https://api.getresponse.com/v3/from-fields\n```\n\n### Implicit flow\n\nFirst, your application must redirect a resource owner to the following URL:\n\n```\nhttps://app.getresponse.com/oauth2_authorize.html?response_type=token&client_id=_your_client_id_&redirect_uri=https://myredirecturi.com/cb&state=xyz\n```\n\nWhen the resource owner grants your application access to the resource, we will redirect the owner to the URL that was specified in the request.\n\nThere is no code exchange process because, unlike the Authorization Code flow, the redirect already has the access token in the parameters.\n\n```\nhttps://myredirecturi.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA&state=xyz&token_type=bearer&expires_in=3600\n```\n\n### Refresh Token flow\n\nYou need to refresh your access token if you receive this error message as a response to your request:\n\n```json\n{\n \"httpStatus\": 401,\n \"code\": 1014,\n \"codeDescription\": \"Problem during authentication process, check headers!\",\n \"message\": \"The access token provided is expired\",\n \"moreInfo\": \"https://apidocs.getresponse.com/v3/errors/1014\",\n \"context\": {\n \"sentToken\": \"b8b1e961a7f9fd4cc710d5d955e09c15a364ab71\"\n }\n}\n```\n\nIf you are using the Authorization Code flow, you need to use the refresh token to issue a new access token/refresh token pair by making the following request:\n\n```\n$ curl -u client_id:client_secret https://api.getresponse.com/v3/token \\\n -d 'grant_type=refresh_token&refresh_token=170d9f64e781aaa6b3ba036083faba71b2fc4e6c'\n```\n\n*Remember to replace `client_id` and `client_secret` with your OAuth application credentials.*\n\nThe response you'll get will look like this:\n\n```json\n{\n \"access_token\": \"890fdsa2f5d7b189fc4e6c4b1d170d9f591238ss\",\n \"expires_in\": 86400,\n \"token_type\": \"Bearer\",\n \"scope\": null,\n \"refresh_token\": \"170d9f64e781aaa6b3ba036083faba71b2fc4e6c\"\n}\n```\n\n### GetResponse MAX\n\nThere are some differences when authenticating GetResponse MAX users:\n\n- the application must redirect to a page in the client's custom domain, for example: `https://custom-domain.getresponse360.com/oauth2_authorize.html`\n- token requests have to be send to one of the GetResponse MAX APIv3 endpoints (depending on the client's environment),\n- token requests have to include an `X-Domain` header,\n- the application has to be registered in a GetResponse MAX account within the same environment.\n\n\n# CORS (AJAX requests)\n\n[Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) mechanism is not supported by APIv3. It means that AJAX requests to the API will be blocked by the browser's [same-origin policy](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy). Please use a server-side application to access the API.\n\n\n# Timezone settings\n\nThe default timezone in response data is **UTC**.\n\nTo set a different timezone, add `X-Time-Zone` header with value of [time zone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) (\"TZ database name\" column).\n\n\n# Pagination\n\nMost of the resource collections returned by API are paginated. It means that the response is divided into multiple pages.\n\nControl the number of results on each page by using `perPage` query parameter and change pages by using `page` query parameter.\n\nBy default we return only the first **100** resources per page. You can change that by adding `perPage` parameter with a value of up to **1000**.\n\nPage numbers start with **1**.\n\nPaginated responses have 3 extra headers:\n* `TotalCount` – a total number of resources on all pages\n* `TotalPages` – a total number of pages\n* `CurrentPage` – current page number\n\nUse the maximum `perPage` value (**1000**) if you plan to iterate over all the pages of the response.\n\nWhen trying to get a page that exceeds the total number of pages, API will return an empty array (`[]`). Make sure to stop iterating when it happens.\n\n\n# CURLE_SSL_CACERT error\n\nSolution to CURLE_SSL_CACERT error (code 60).\n\nThis error is related to expired CA (Certificate Authority) certificates installed on your server (the server that you send the requests from). You can read more about certificate verification on the [cURL project website](https://curl.haxx.se/docs/sslcerts.html).\n\nIf you encounter this error while sending requests to the GetResponse APIv3, ask your server administrator to update the CA certificates using the [latest bundle provided by the cURL project](https://curl.haxx.se/docs/caextract.html).\n\n**Please make sure that cURL is configured to use the updated bundle.**\n", + "apiTitle": "GetResponse APIv3", + "endpoints": 134, + "sdkMethods": 280, + "schemas": 310, + "parameters": 649, + "contactUrl": "https://app.getresponse.com/feedback.html?devzone=yes", + "contactEmail": "getresponse-devzone@cs.getresponse.com", + "originalCustomRequest": { + "type": "GET", + "url": "https://apireference.getresponse.com/open-api.json" + }, + "customRequestSpecFilename": "getresponse.com.yaml", + "difficultyScore": 626.25, + "difficulty": "Very Hard", + "company": "GetResponse", + "sdkName": "get-response-{language}-sdk", + "clientName": "GetResponse", + "metaDescription": "GetResponse is a comprehensive email marketing platform that provides small businesses, solopreneurs, coaches, and marketers with powerful and affordable tools to grow their audience, engage with their subscribers, and turn subscribers into paying customers. With over 25 years of expertise, our customers choose GetResponse for our user-friendly solution, award-winning 24/7 customer support, and powerful tools that go beyond email marketing – with automation, list growth, and additional communication tools like webinars and live chats to help businesses build their personal brand, sell their products and services, and build a community.\n\nGetResponse's powerful email marketing software includes AI-enhanced content creation tools, professional templates, easy-to-use design tools, and proven deliverability. Our customers are empowered with tools to build a website and unlimited landing pages, and create engaging pop-ups and signup forms. The marketing automation builder brings your ideal automated communication scenario to life with a visual builder that can grow with your needs.\n\nWith our easy-to-use platform, proven expertise, and focus on user-friendly solutions, GetResponse is the ideal tool for small businesses, solopreneurs, coaches, and marketers looking to grow their audience, sell their products and services, and engage with their subscribers in a meaningful way.", + "apiStatusUrls": "inherit", + "homepage": "getresponse.com", + "developerDocumentation": "apireference.getresponse.com/", + "categories": [ + "email", + "marketing", + "email_marketing", + "marketing_automation", + "webinar_funnels" + ], + "category": "Email", + "methods": [ + { + "url": "/webinars/{webinarId}", + "method": "getById", + "httpMethod": "get", + "tag": "Webinars", + "typeScriptTag": "webinars", + "description": "Get a webinar by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/contacts/{contactId}", + "method": "deleteById", + "httpMethod": "delete", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Delete a contact by contact ID", + "parameters": [ + { + "name": "messageId", + "schema": "string", + "required": false, + "description": ">\nThe ID of a message (such as a newsletter, an autoresponder, or an RSS-newsletter).\nWhen passed, this method will simulate the unsubscribe process, as if the contact clicked the unsubscribe link in a given message." + }, + { + "name": "ipAddress", + "schema": "string", + "description": "This makes it possible to pass the IP from which the contact unsubscribed. Used only if the `messageId` was send." + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Empty response." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/contacts/{contactId}", + "method": "getDetailsById", + "httpMethod": "get", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Get contact details by contact ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/contacts/{contactId}", + "method": "updateDetails", + "httpMethod": "post", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Update contact details", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/contacts/{contactId}/activities", + "method": "getListOfActivities", + "httpMethod": "get", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Get a list of contact activities", + "parameters": [ + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/campaigns/{campaignId}/contacts", + "method": "getSingleCampaignContacts", + "httpMethod": "get", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Get contacts from a single campaign", + "parameters": [ + { + "name": "query[email]", + "schema": "string", + "required": false, + "description": "Search contacts by email" + }, + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search contacts by name" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Count data from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Count data to this date" + }, + { + "name": "sort[email]", + "schema": "string", + "required": false, + "description": "Sort contacts by email" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort contacts by name" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort contacts by creation date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/contacts/{contactId}/custom-fields", + "method": "upsertCustomFields", + "httpMethod": "post", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Upsert the custom fields of a contact", + "parameters": [ + { + "name": "customFieldValues", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/contacts/{contactId}/tags", + "method": "upsertContactTags", + "httpMethod": "post", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Upsert the tags of a contact", + "parameters": [ + { + "name": "tags", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/search-contacts/{searchContactId}", + "method": "deleteById", + "httpMethod": "delete", + "tag": "Search Contacts", + "typeScriptTag": "searchContacts", + "description": "Delete search contacts", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete search contacts." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/search-contacts/{searchContactId}", + "method": "byContactId", + "httpMethod": "get", + "tag": "Search Contacts", + "typeScriptTag": "searchContacts", + "description": "Get search contacts by contact ID.", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Search contact details." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/search-contacts/{searchContactId}", + "method": "updateSpecifiedContacts", + "httpMethod": "post", + "tag": "Search Contacts", + "typeScriptTag": "searchContacts", + "description": "Update search contacts", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "Search contact details." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/search-contacts/{searchContactId}/contacts", + "method": "byId", + "httpMethod": "get", + "tag": "Search Contacts", + "typeScriptTag": "searchContacts", + "description": "Get contacts by search contacts ID", + "parameters": [ + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name", + "example": "desc" + }, + { + "name": "sort[email]", + "schema": "string", + "required": false, + "description": "Sort by email", + "example": "desc" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by creation date", + "example": "asc" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/search-contacts/{searchContactId}/custom-fields", + "method": "upsertCustomFieldsByContactId", + "httpMethod": "post", + "tag": "Search Contacts", + "typeScriptTag": "searchContacts", + "description": "Upsert custom fields by search contacts", + "parameters": [ + { + "name": "customFieldValues", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "202", + "description": "Upsert custom fields by searchContactId." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/transactional-emails/templates/{transactionalTemplateId}", + "method": "deleteTemplate", + "httpMethod": "delete", + "tag": "Transactional Emails Templates", + "typeScriptTag": "transactionalEmailsTemplates", + "description": "Delete transactional email template", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete transactional email template" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/transactional-emails/templates/{transactionalTemplateId}", + "method": "getById", + "httpMethod": "get", + "tag": "Transactional Emails Templates", + "typeScriptTag": "transactionalEmailsTemplates", + "description": "Get a single template by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/transactional-emails/templates/{transactionalTemplateId}", + "method": "updateTemplate", + "httpMethod": "post", + "tag": "Transactional Emails Templates", + "typeScriptTag": "transactionalEmailsTemplates", + "description": "Update transactional email template", + "parameters": [ + { + "name": "subject", + "schema": "string", + "description": "", + "example": "Order Confirmation - Example Shop" + }, + { + "name": "content", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/transactional-emails/{transactionalEmailId}", + "method": "getDetailsById", + "httpMethod": "get", + "tag": "Transactional Emails", + "typeScriptTag": "transactionalEmails", + "description": "Get transactional email details by transactional email ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/from-fields/{fromFieldId}", + "method": "deleteAddress", + "httpMethod": "delete", + "tag": "From Fields", + "typeScriptTag": "fromFields", + "description": "Delete 'From' address", + "parameters": [ + { + "name": "fromFieldIdToReplaceWith", + "schema": "string", + "required": false, + "description": "The 'From' address ID that should replace the deleted 'From' address" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Delete 'From' address." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/from-fields/{fromFieldId}", + "method": "getSingleAddressById", + "httpMethod": "get", + "tag": "From Fields", + "typeScriptTag": "fromFields", + "description": "Get a single 'From' address by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/from-fields/{fromFieldId}/default", + "method": "setFromAddressAsDefault", + "httpMethod": "post", + "tag": "From Fields", + "typeScriptTag": "fromFields", + "description": "Set a 'From' address as default", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "Set a 'From' address as default." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/rss-newsletters/{rssNewsletterId}", + "method": "deleteNewsletter", + "httpMethod": "delete", + "tag": "RSS Newsletters", + "typeScriptTag": "rssNewsletters", + "description": "Delete RSS newsletter", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete RSS newsletter." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/rss-newsletters/{rssNewsletterId}", + "method": "getById", + "httpMethod": "get", + "tag": "RSS Newsletters", + "typeScriptTag": "rssNewsletters", + "description": "Get RSS newsletter by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/rss-newsletters/{rssNewsletterId}", + "method": "updateNewsletter", + "httpMethod": "post", + "tag": "RSS Newsletters", + "typeScriptTag": "rssNewsletters", + "description": "Update RSS newsletter", + "parameters": [ + { + "name": "rssNewsletterId", + "schema": "string", + "required": true, + "description": "", + "example": "dGer" + }, + { + "name": "href", + "schema": "string", + "required": true, + "description": "", + "example": "https://api.getresponse.com/v3/rss-newsletters/dGer" + }, + { + "name": "rssFeedUrl", + "schema": "string", + "required": false, + "description": "", + "example": "http://blog.getresponse.com" + }, + { + "name": "subject", + "schema": "string", + "required": false, + "description": "", + "example": "My rss to newsletters" + }, + { + "name": "name", + "schema": "string", + "required": false, + "description": "", + "example": "rsstest0" + }, + { + "name": "status", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "editor", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "fromField", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "replyTo", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "content", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "sendSettings", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "createdOn", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/rss-newsletters/{rssNewsletterId}/statistics", + "method": "getStatisticsById", + "httpMethod": "get", + "tag": "RSS Newsletters", + "typeScriptTag": "rssNewsletters", + "description": "Get RSS newsletter statistics by ID", + "parameters": [ + { + "name": "query[groupBy]", + "schema": "string", + "required": false, + "description": "Group results by time interval" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Count data from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Count data to this date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/taxes", + "method": "getList", + "httpMethod": "get", + "tag": "Taxes", + "typeScriptTag": "taxes", + "description": "Get a list of taxes", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search tax by name" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Search tax created from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Search tax created to this date" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/taxes", + "method": "createNewTax", + "httpMethod": "post", + "tag": "Taxes", + "typeScriptTag": "taxes", + "description": "Create tax", + "parameters": [ + { + "name": "taxId", + "schema": "string", + "description": "", + "example": "Sk" + }, + { + "name": "href", + "schema": "string", + "description": "", + "example": "https://api.getresponse.com/v3/shops/pf3/taxes/Sk" + }, + { + "name": "name", + "schema": "string", + "description": "", + "example": "VAT" + }, + { + "name": "rate", + "schema": "number", + "description": "", + "example": 23 + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/taxes/{taxId}", + "method": "deleteById", + "httpMethod": "delete", + "tag": "Taxes", + "typeScriptTag": "taxes", + "description": "Delete tax by ID", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete tax" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/taxes/{taxId}", + "method": "getSingleById", + "httpMethod": "get", + "tag": "Taxes", + "typeScriptTag": "taxes", + "description": "Get a single tax by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/taxes/{taxId}", + "method": "updateShopTax", + "httpMethod": "post", + "tag": "Taxes", + "typeScriptTag": "taxes", + "description": "Update tax", + "parameters": [ + { + "name": "taxId", + "schema": "string", + "description": "", + "example": "Sk" + }, + { + "name": "href", + "schema": "string", + "description": "", + "example": "https://api.getresponse.com/v3/shops/pf3/taxes/Sk" + }, + { + "name": "name", + "schema": "string", + "description": "", + "example": "VAT" + }, + { + "name": "rate", + "schema": "number", + "description": "", + "example": 23 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/custom-events/{customEventId}", + "method": "deleteEventById", + "httpMethod": "delete", + "tag": "Custom Events", + "typeScriptTag": "customEvents", + "description": "Delete a custom event by custom event ID", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete custom event" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/custom-events/{customEventId}", + "method": "getById", + "httpMethod": "get", + "tag": "Custom Events", + "typeScriptTag": "customEvents", + "description": "Get custom events by custom event ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/custom-events/{customEventId}", + "method": "updateDetails", + "httpMethod": "post", + "tag": "Custom Events", + "typeScriptTag": "customEvents", + "description": "Update custom event details", + "parameters": [ + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "sample_custom_event" + }, + { + "name": "attributes", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/forms/{formId}", + "method": "getById", + "httpMethod": "get", + "tag": "Forms", + "typeScriptTag": "forms", + "description": "Get form by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/forms/{formId}/variants", + "method": "getListOfVariants", + "httpMethod": "get", + "tag": "Forms", + "typeScriptTag": "forms", + "description": "Get the list of form variants (A/B tests)", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/landing-pages/{landingPageId}", + "method": "getById", + "httpMethod": "get", + "tag": "Legacy Landing Pages", + "typeScriptTag": "legacyLandingPages", + "description": "Get single landing page by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/imports/{importId}", + "method": "getImportDetailsById", + "httpMethod": "get", + "tag": "Imports", + "typeScriptTag": "imports", + "description": "Get import details by ID.", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/statistics/sms/{smsId}", + "method": "getMessageStatistics", + "httpMethod": "get", + "tag": "Sms", + "typeScriptTag": "sms", + "description": "Get details for the SMS message statistics", + "parameters": [ + { + "name": "query[createdOn][from]", + "schema": "string", + "description": "Get statistics for a single SMS from this date", + "example": "2023-01-20" + }, + { + "name": "query[createdOn][to]", + "schema": "string", + "description": "Get statistics for a single SMS to this date", + "example": "2023-01-20" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/predefined-fields/{predefinedFieldId}", + "method": "deleteField", + "httpMethod": "delete", + "tag": "Predefined Fields", + "typeScriptTag": "predefinedFields", + "description": "Delete a predefined field", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete a predefined field." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/predefined-fields/{predefinedFieldId}", + "method": "getById", + "httpMethod": "get", + "tag": "Predefined Fields", + "typeScriptTag": "predefinedFields", + "description": "Get a predefined field by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/predefined-fields/{predefinedFieldId}", + "method": "updateField", + "httpMethod": "post", + "tag": "Predefined Fields", + "typeScriptTag": "predefinedFields", + "description": "Update a predefined field", + "parameters": [ + { + "name": "value", + "schema": "string", + "required": true, + "description": "", + "example": "my_new_value" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/categories", + "method": "list", + "httpMethod": "get", + "tag": "Categories", + "typeScriptTag": "categories", + "description": "Get the shop categories list", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search category by name" + }, + { + "name": "query[parentId]", + "schema": "string", + "required": false, + "description": "Search categories by their parent" + }, + { + "name": "query[externalId]", + "schema": "string", + "required": false, + "description": "Search categories by external ID" + }, + { + "name": "search[createdAt][from]", + "schema": "string", + "required": false, + "description": "Show categories starting from this date" + }, + { + "name": "search[createdAt][to]", + "schema": "string", + "required": false, + "description": "Show categories starting to this date" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name" + }, + { + "name": "sort[createdAt]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/categories", + "method": "createNewCategory", + "httpMethod": "post", + "tag": "Categories", + "typeScriptTag": "categories", + "description": "Create category", + "parameters": [], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/categories/{categoryId}", + "method": "deleteCategory", + "httpMethod": "delete", + "tag": "Categories", + "typeScriptTag": "categories", + "description": "Delete category", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete category" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/categories/{categoryId}", + "method": "getById", + "httpMethod": "get", + "tag": "Categories", + "typeScriptTag": "categories", + "description": "Get a single category by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/categories/{categoryId}", + "method": "updateCategoryProperties", + "httpMethod": "post", + "tag": "Categories", + "typeScriptTag": "categories", + "description": "Update category", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/suppressions/{suppressionId}", + "method": "deleteById", + "httpMethod": "delete", + "tag": "Suppressions", + "typeScriptTag": "suppressions", + "description": "Deletes a given suppression list by ID", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Suppression list deleted successfully." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/suppressions/{suppressionId}", + "method": "getSuppressionListById", + "httpMethod": "get", + "tag": "Suppressions", + "typeScriptTag": "suppressions", + "description": "Get a suppression list by ID", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/suppressions/{suppressionId}", + "method": "updateById", + "httpMethod": "post", + "tag": "Suppressions", + "typeScriptTag": "suppressions", + "description": "Update a suppression list by ID", + "parameters": [ + { + "name": "name", + "schema": "string", + "description": "", + "example": "suppression-name" + }, + { + "name": "masks", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/orders", + "method": "getList", + "httpMethod": "get", + "tag": "Orders", + "typeScriptTag": "orders", + "description": "Get the list of orders", + "parameters": [ + { + "name": "query[description]", + "schema": "string", + "required": false, + "description": "Search order by description" + }, + { + "name": "query[status]", + "schema": "string", + "required": false, + "description": "Search order by status" + }, + { + "name": "query[externalId]", + "schema": "string", + "required": false, + "description": "Search order by external ID" + }, + { + "name": "query[processedAt][from]", + "schema": "string", + "required": false, + "description": "Show orders processed from this date" + }, + { + "name": "query[processedAt][to]", + "schema": "string", + "required": false, + "description": "Show orders processed to this date" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/orders", + "method": "createNewOrder", + "httpMethod": "post", + "tag": "Orders", + "typeScriptTag": "orders", + "description": "Create order", + "parameters": [ + { + "name": "additionalFlags", + "schema": "string", + "required": false, + "description": "The additional flags parameter with the value `skipAutomation` will skip the triggering `Make a purchase` element in an automated workflow", + "example": "skipAutomation" + }, + { + "name": "description", + "schema": "string", + "description": "", + "example": "More information about order." + }, + { + "name": "orderId", + "schema": "string", + "description": "", + "example": "fOh" + }, + { + "name": "href", + "schema": "string", + "description": "", + "example": "https://api.getresponse.com/v3/shops/pf3/orders/fOh" + }, + { + "name": "contactId", + "schema": "string", + "description": "", + "example": "k8u" + }, + { + "name": "orderUrl", + "schema": "string", + "description": "", + "example": "https://somedomain.com/orders/order446" + }, + { + "name": "externalId", + "schema": "string", + "description": "", + "example": "DH71239" + }, + { + "name": "totalPrice", + "schema": "number", + "description": "", + "example": 716 + }, + { + "name": "totalPriceTax", + "schema": "number", + "description": "", + "example": 358.67 + }, + { + "name": "currency", + "schema": "string", + "description": "", + "example": "PLN" + }, + { + "name": "status", + "schema": "string", + "description": "", + "example": "NEW" + }, + { + "name": "cartId", + "schema": "string", + "description": "", + "example": "QBNgBR" + }, + { + "name": "shippingPrice", + "schema": "number", + "description": "", + "example": 23 + }, + { + "name": "shippingAddress", + "schema": "object", + "description": "" + }, + { + "name": "billingStatus", + "schema": "string", + "description": "", + "example": "PENDING" + }, + { + "name": "billingAddress", + "schema": "object", + "description": "" + }, + { + "name": "processedAt", + "schema": "string", + "description": "" + }, + { + "name": "metaFields", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/orders/{orderId}", + "method": "deleteOrder", + "httpMethod": "delete", + "tag": "Orders", + "typeScriptTag": "orders", + "description": "Delete order", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete order" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/orders/{orderId}", + "method": "getById", + "httpMethod": "get", + "tag": "Orders", + "typeScriptTag": "orders", + "description": "Get a single order by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/orders/{orderId}", + "method": "updateOrder", + "httpMethod": "post", + "tag": "Orders", + "typeScriptTag": "orders", + "description": "Update order", + "parameters": [ + { + "name": "additionalFlags", + "schema": "string", + "required": false, + "description": "The additional flags parameter with the value `skipAutomation` will skip the triggering `Make a purchase` element in an automated workflow", + "example": "skipAutomation" + }, + { + "name": "description", + "schema": "string", + "description": "", + "example": "More information about order." + }, + { + "name": "orderId", + "schema": "string", + "description": "", + "example": "fOh" + }, + { + "name": "href", + "schema": "string", + "description": "", + "example": "https://api.getresponse.com/v3/shops/pf3/orders/fOh" + }, + { + "name": "contactId", + "schema": "string", + "description": "", + "example": "k8u" + }, + { + "name": "orderUrl", + "schema": "string", + "description": "", + "example": "https://somedomain.com/orders/order446" + }, + { + "name": "externalId", + "schema": "string", + "description": "", + "example": "DH71239" + }, + { + "name": "totalPrice", + "schema": "number", + "description": "", + "example": 716 + }, + { + "name": "totalPriceTax", + "schema": "number", + "description": "", + "example": 358.67 + }, + { + "name": "currency", + "schema": "string", + "description": "", + "example": "PLN" + }, + { + "name": "status", + "schema": "string", + "description": "", + "example": "NEW" + }, + { + "name": "cartId", + "schema": "string", + "description": "", + "example": "QBNgBR" + }, + { + "name": "shippingPrice", + "schema": "number", + "description": "", + "example": 23 + }, + { + "name": "shippingAddress", + "schema": "object", + "description": "" + }, + { + "name": "billingStatus", + "schema": "string", + "description": "", + "example": "PENDING" + }, + { + "name": "billingAddress", + "schema": "object", + "description": "" + }, + { + "name": "processedAt", + "schema": "string", + "description": "" + }, + { + "name": "metaFields", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/products", + "method": "getList", + "httpMethod": "get", + "tag": "Products", + "typeScriptTag": "products", + "description": "Get a product list.", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search products by name" + }, + { + "name": "query[vendor]", + "schema": "string", + "required": false, + "description": "Search products by vendor" + }, + { + "name": "query[category]", + "schema": "string", + "required": false, + "description": "Search products by category name" + }, + { + "name": "query[categoryId]", + "schema": "string", + "required": false, + "description": "Search products by category ID" + }, + { + "name": "query[externalId]", + "schema": "string", + "required": false, + "description": "Search products by external ID" + }, + { + "name": "query[variantName]", + "schema": "string", + "required": false, + "description": "Search products by product variant name" + }, + { + "name": "query[metaFieldNames]", + "schema": "string", + "required": false, + "description": "Search products by meta field name (the list of names must be separated by a comma [,])" + }, + { + "name": "query[metaFieldValues]", + "schema": "string", + "required": false, + "description": "Search products by meta field value (the list of values must be separated by a comma [,])" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Search products created from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Search products created to this date" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/products", + "method": "createProduct", + "httpMethod": "post", + "tag": "Products", + "typeScriptTag": "products", + "description": "Create product", + "parameters": [ + { + "name": "createdOn", + "schema": "string", + "description": "" + }, + { + "name": "updatedOn", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/products/{productId}", + "method": "deleteProduct", + "httpMethod": "delete", + "tag": "Products", + "typeScriptTag": "products", + "description": "Delete product", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete product" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/products/{productId}", + "method": "getByShopIdAndProductId", + "httpMethod": "get", + "tag": "Products", + "typeScriptTag": "products", + "description": "Get a single product by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/products/{productId}", + "method": "updateProduct", + "httpMethod": "post", + "tag": "Products", + "typeScriptTag": "products", + "description": "Update product", + "parameters": [ + { + "name": "createdOn", + "schema": "string", + "description": "" + }, + { + "name": "updatedOn", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/products/{productId}/categories", + "method": "upsertCategories", + "httpMethod": "post", + "tag": "Products", + "typeScriptTag": "products", + "description": "Upsert product categories", + "parameters": [ + { + "name": "categories", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/products/{productId}/meta-fields", + "method": "upsertMetaFields", + "httpMethod": "post", + "tag": "Products", + "typeScriptTag": "products", + "description": "Upsert product meta fields", + "parameters": [ + { + "name": "metaFields", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}", + "method": "deleteShop", + "httpMethod": "delete", + "tag": "Shops", + "typeScriptTag": "shops", + "description": "Delete shop", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete a shop" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}", + "method": "getById", + "httpMethod": "get", + "tag": "Shops", + "typeScriptTag": "shops", + "description": "Get a single shop by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}", + "method": "updatePreferences", + "httpMethod": "post", + "tag": "Shops", + "typeScriptTag": "shops", + "description": "Update shop", + "parameters": [ + { + "name": "createdOn", + "schema": "string", + "description": "" + }, + { + "name": "updatedOn", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/popups/{popupId}", + "method": "getFormOrPopupById", + "httpMethod": "get", + "tag": "Forms and Popups", + "typeScriptTag": "formsAndPopups", + "description": "Get a single form or popup by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/statistics/popups/{popupId}/performance", + "method": "getPerformanceStatsSinglePopup", + "httpMethod": "get", + "tag": "Form and Popup", + "typeScriptTag": "formAndPopup", + "description": "Get statistics for a single form or popup", + "parameters": [ + { + "name": "query[date][from]", + "schema": "string", + "required": false, + "description": "Get statistics for a single form or popup from this date", + "example": "2023-01-10" + }, + { + "name": "query[date][to]", + "schema": "string", + "required": false, + "description": "Get statistics for a single form or popup to this date", + "example": "2023-01-20" + }, + { + "name": "query[location]", + "schema": "string", + "required": false, + "description": "Form or popup statistics by location" + }, + { + "name": "query[device]", + "schema": "string", + "required": false, + "description": "Form or popup statistics by device" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/splittests/{splittestId}", + "method": "getSingleAbTestById", + "httpMethod": "get", + "tag": "A/B tests", + "typeScriptTag": "aBTests", + "description": "Get a single A/B test.", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/carts", + "method": "getShopCarts", + "httpMethod": "get", + "tag": "Carts", + "typeScriptTag": "carts", + "description": "Get shop carts", + "parameters": [ + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Search carts created from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Search carts created to this date" + }, + { + "name": "query[externalId]", + "schema": "string", + "required": false, + "description": "Search cart by external ID" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/carts", + "method": "createNewCart", + "httpMethod": "post", + "tag": "Carts", + "typeScriptTag": "carts", + "description": "Create cart", + "parameters": [ + { + "name": "createdOn", + "schema": "string", + "description": "" + }, + { + "name": "updatedOn", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/carts/{cartId}", + "method": "deleteCart", + "httpMethod": "delete", + "tag": "Carts", + "typeScriptTag": "carts", + "description": "Delete cart", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete cart" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/carts/{cartId}", + "method": "getByIdInShopContext", + "httpMethod": "get", + "tag": "Carts", + "typeScriptTag": "carts", + "description": "Get cart by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/carts/{cartId}", + "method": "updateCartProperties", + "httpMethod": "post", + "tag": "Carts", + "typeScriptTag": "carts", + "description": "Update cart", + "parameters": [ + { + "name": "createdOn", + "schema": "string", + "description": "" + }, + { + "name": "updatedOn", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/file-library/files/{fileId}", + "method": "deleteFileById", + "httpMethod": "delete", + "tag": "File Library", + "typeScriptTag": "fileLibrary", + "description": "Delete file by file ID", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete file" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/file-library/files/{fileId}", + "method": "getFileById", + "httpMethod": "get", + "tag": "File Library", + "typeScriptTag": "fileLibrary", + "description": "Get file by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/file-library/folders/{folderId}", + "method": "deleteFolderById", + "httpMethod": "delete", + "tag": "File Library", + "typeScriptTag": "fileLibrary", + "description": "Delete folder by folder ID", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete folder" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/ab-tests/subject/{abTestId}", + "method": "getSingleById", + "httpMethod": "get", + "tag": "A/B tests - subject", + "typeScriptTag": "aBTestsSubject", + "description": "Get a single A/B test by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/ab-tests/subject/{abTestId}/winner", + "method": "chooseWinner", + "httpMethod": "post", + "tag": "A/B tests - subject", + "typeScriptTag": "aBTestsSubject", + "description": "Choose A/B test winner", + "parameters": [ + { + "name": "variantId", + "schema": "string", + "required": true, + "description": "", + "example": "VpKJdr" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Choose A/B test winner" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/click-tracks/{clickTrackId}", + "method": "getLinkDetailsById", + "httpMethod": "get", + "tag": "Click Tracks", + "typeScriptTag": "clickTracks", + "description": "Get click tracked link details by click track ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/newsletters/{newsletterId}", + "method": "deleteNewsletter", + "httpMethod": "delete", + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "Delete newsletter", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete newsletter." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/newsletters/{newsletterId}", + "method": "getSingleById", + "httpMethod": "get", + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "Get a single newsletter by its ID.", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/newsletters/{newsletterId}/activities", + "method": "getActivities", + "httpMethod": "get", + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "Get newsletter activities", + "parameters": [ + { + "name": "query[activity]", + "schema": "string", + "required": false, + "description": "Search newsletter activities by activity type" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Search newsletter activities from this date. Default value is 14 days earlier. You can get activities for last 30 days only." + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Search newsletter activities to this date. Default value is now" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/newsletters/{newsletterId}/cancel", + "method": "cancelSending", + "httpMethod": "post", + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "Cancel sending the newsletter", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/newsletters/{newsletterId}/thumbnail", + "method": "getThumbnail", + "httpMethod": "get", + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "Get newsletter thumbnail", + "parameters": [ + { + "name": "size", + "schema": "string", + "required": false, + "description": "The size of the thumbnail", + "default": "default" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/newsletters/{newsletterId}/statistics", + "method": "getStatistics", + "httpMethod": "get", + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "The statistics of single newsletter", + "parameters": [ + { + "name": "query[groupBy]", + "schema": "string", + "required": false, + "description": "Group results by time interval" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Count data from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Count data to this date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/tags/{tagId}", + "method": "deleteById", + "httpMethod": "delete", + "tag": "Tags", + "typeScriptTag": "tags", + "description": "Delete tag by ID", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Tag deleted successfully." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/tags/{tagId}", + "method": "getById", + "httpMethod": "get", + "tag": "Tags", + "typeScriptTag": "tags", + "description": "Get tag by ID", + "parameters": [ + { + "name": "tagId", + "schema": "string", + "required": true, + "description": "The tag ID", + "example": "TAGID" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/tags/{tagId}", + "method": "updateById", + "httpMethod": "post", + "tag": "Tags", + "typeScriptTag": "tags", + "description": "Update tag by ID", + "parameters": [ + { + "name": "name", + "schema": "string", + "description": "", + "example": "My_Tag" + }, + { + "name": "color", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/addresses/{addressId}", + "method": "deleteAddress", + "httpMethod": "delete", + "tag": "Addresses", + "typeScriptTag": "addresses", + "description": "Delete address", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Empty response" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/addresses/{addressId}", + "method": "getAddressById", + "httpMethod": "get", + "tag": "Addresses", + "typeScriptTag": "addresses", + "description": "Get an address by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/addresses/{addressId}", + "method": "updateAddress", + "httpMethod": "post", + "tag": "Addresses", + "typeScriptTag": "addresses", + "description": "Update address", + "parameters": [ + { + "name": "createdOn", + "schema": "string", + "description": "" + }, + { + "name": "updatedOn", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/campaigns/{campaignId}/blocklists", + "method": "getBlocklistMasks", + "httpMethod": "get", + "tag": "Campaigns (https://apireference.getresponse.com/", + "typeScriptTag": "campaignsHttps:ApireferenceGetresponseCom", + "description": "Returns campaign blocklist masks", + "parameters": [ + { + "name": "query[mask]", + "schema": "string", + "required": false, + "description": "Blocklist mask to search for", + "example": "@somedomain.com" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/campaigns/{campaignId}/blocklists", + "method": "updateBlocklistMasks", + "httpMethod": "post", + "tag": "Campaigns (https://apireference.getresponse.com/", + "typeScriptTag": "campaignsHttps:ApireferenceGetresponseCom", + "description": "Updates campaign blocklist masks", + "parameters": [ + { + "name": "additionalFlags", + "schema": "string", + "required": false, + "description": "The flag value `add` adds the masks provided in the request body to your blocklist. The flag value `delete` deletes the masks. The masks are replaced if there are no flag values in the request body. \n\n For better performance, use the flag value `noResponse`. It removes the response body and can be used alone or combined with other flags. If multiple flags are used, separate them by a comma, like this: `additionalFlags=noResponse` or `additionalFlags=add,noResponse`." + }, + { + "name": "masks", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/custom-fields/{customFieldId}", + "method": "deleteSingleCustomField", + "httpMethod": "delete", + "tag": "Custom Fields", + "typeScriptTag": "customFields", + "description": "Delete a single custom field definition", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete a custom field." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/custom-fields/{customFieldId}", + "method": "getDefinitionById", + "httpMethod": "get", + "tag": "Custom Fields", + "typeScriptTag": "customFields", + "description": "Get a single custom field definition by the custom field ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/custom-fields/{customFieldId}", + "method": "updateDefinition", + "httpMethod": "post", + "tag": "Custom Fields", + "typeScriptTag": "customFields", + "description": "Update the custom field definition", + "parameters": [ + { + "name": "hidden", + "schema": "string", + "required": true, + "description": "", + "example": "HIDDEN" + }, + { + "name": "values", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/lps/{lpsId}", + "method": "getById", + "httpMethod": "get", + "tag": "Landing Pages", + "typeScriptTag": "landingPages", + "description": "Get a single landing page by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/statistics/lps/{lpsId}/performance", + "method": "getPerformanceDetails", + "httpMethod": "get", + "tag": "Landing Page", + "typeScriptTag": "landingPage", + "description": "Get details for landing page statistics", + "parameters": [ + { + "name": "query[date][from]", + "schema": "undefined", + "required": false, + "description": "Show a single landing page statistics from this date" + }, + { + "name": "query[date][to]", + "schema": "undefined", + "required": false, + "description": "Show a single landing page statistics to this date" + }, + { + "name": "query[location]", + "schema": "string", + "required": false, + "description": "Landing page statistics by location" + }, + { + "name": "query[device]", + "schema": "string", + "required": false, + "description": "Landing page statistics by device" + }, + { + "name": "query[page]", + "schema": "string", + "required": false, + "description": "Landing page statistics by page UUID" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/products/{productId}/variants", + "method": "getProductVariantsList", + "httpMethod": "get", + "tag": "Product Variants", + "typeScriptTag": "productVariants", + "description": "Get a list of product variants", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search variant by name" + }, + { + "name": "query[sku]", + "schema": "string", + "required": false, + "description": "Search variant by SKU" + }, + { + "name": "query[description]", + "schema": "string", + "required": false, + "description": "Search variant by description" + }, + { + "name": "query[externalId]", + "schema": "string", + "required": false, + "description": "Search variant by external ID" + }, + { + "name": "query[createdAt][from]", + "schema": "string", + "required": false, + "description": "Show variants starting from this date" + }, + { + "name": "query[createdAt][to]", + "schema": "string", + "required": false, + "description": "Show variants starting to this date" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/products/{productId}/variants", + "method": "createNewVariant", + "httpMethod": "post", + "tag": "Product Variants", + "typeScriptTag": "productVariants", + "description": "Create product variant", + "parameters": [ + { + "name": "description", + "schema": "string", + "description": "", + "example": "Red Cap with GetResponse Monster print" + }, + { + "name": "variantId", + "schema": "string", + "description": "", + "example": "VTB" + }, + { + "name": "href", + "schema": "string", + "description": "", + "example": "https://api.getresponse.com/v3/shops/pf3/products/9I/variants/VTB" + }, + { + "name": "name", + "schema": "string", + "description": "", + "example": "Red Monster Cap" + }, + { + "name": "url", + "schema": "string", + "description": "", + "example": "https://somedomain.com/products-variants/986" + }, + { + "name": "sku", + "schema": "string", + "description": "", + "example": "SKU-1254-56-457-5689" + }, + { + "name": "price", + "schema": "number", + "description": "", + "example": 20 + }, + { + "name": "priceTax", + "schema": "number", + "description": "", + "example": 27.5 + }, + { + "name": "previousPrice", + "schema": "number", + "description": "", + "example": 25 + }, + { + "name": "previousPriceTax", + "schema": "number", + "description": "", + "example": 33.6 + }, + { + "name": "quantity", + "schema": "integer", + "description": "", + "default": 1 + }, + { + "name": "position", + "schema": "integer", + "description": "", + "example": 1 + }, + { + "name": "barcode", + "schema": "string", + "description": "", + "example": "12455687" + }, + { + "name": "externalId", + "schema": "string", + "description": "", + "example": "ext1456" + }, + { + "name": "images", + "schema": "array", + "description": "" + }, + { + "name": "metaFields", + "schema": "array", + "description": "" + }, + { + "name": "taxes", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/products/{productId}/variants/{variantId}", + "method": "deleteVariant", + "httpMethod": "delete", + "tag": "Product Variants", + "typeScriptTag": "productVariants", + "description": "Delete product variant", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete product variant" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/products/{productId}/variants/{variantId}", + "method": "getById", + "httpMethod": "get", + "tag": "Product Variants", + "typeScriptTag": "productVariants", + "description": "Get a single product variant by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/products/{productId}/variants/{variantId}", + "method": "updateVariantProperties", + "httpMethod": "post", + "tag": "Product Variants", + "typeScriptTag": "productVariants", + "description": "Update product variant", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/campaigns/{campaignId}", + "method": "getSingleCampaign", + "httpMethod": "get", + "tag": "Campaigns (https://apireference.getresponse.com/", + "typeScriptTag": "campaignsHttps:ApireferenceGetresponseCom", + "description": "Get a single campaign by the campaign ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/campaigns/{campaignId}", + "method": "updateCampaign", + "httpMethod": "post", + "tag": "Campaigns (https://apireference.getresponse.com/", + "typeScriptTag": "campaignsHttps:ApireferenceGetresponseCom", + "description": "Update a campaign", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/meta-fields", + "method": "getCollection", + "httpMethod": "get", + "tag": "Meta Fields", + "typeScriptTag": "metaFields", + "description": "Get the shop meta fields", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search meta fields by name" + }, + { + "name": "query[description]", + "schema": "string", + "required": false, + "description": "Search meta fields by description" + }, + { + "name": "query[value]", + "schema": "string", + "required": false, + "description": "Search meta fields by value" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Search meta fields created from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Search meta fields created to this date" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/meta-fields", + "method": "createNewMetaField", + "httpMethod": "post", + "tag": "Meta Fields", + "typeScriptTag": "metaFields", + "description": "Create meta field", + "parameters": [ + { + "name": "description", + "schema": "string", + "description": "", + "example": "Description of this meta field" + }, + { + "name": "href", + "schema": "string", + "description": "", + "example": "https://api.getresponse.com/v3/shops/pf3/meta-fields/NoF" + }, + { + "name": "metaFieldId", + "schema": "string", + "description": "", + "example": "NoF" + }, + { + "name": "name", + "schema": "string", + "description": "", + "example": "Shoe size" + }, + { + "name": "value", + "schema": "string", + "description": "", + "example": "11" + }, + { + "name": "valueType", + "schema": "string", + "description": "", + "example": "integer" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/meta-fields/{metaFieldId}", + "method": "delete", + "httpMethod": "delete", + "tag": "Meta Fields", + "typeScriptTag": "metaFields", + "description": "Delete meta field", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete meta field" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/meta-fields/{metaFieldId}", + "method": "getById", + "httpMethod": "get", + "tag": "Meta Fields", + "typeScriptTag": "metaFields", + "description": "Get the meta field by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops/{shopId}/meta-fields/{metaFieldId}", + "method": "updateProperties", + "httpMethod": "post", + "tag": "Meta Fields", + "typeScriptTag": "metaFields", + "description": "Update meta field", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/webforms/{webformId}", + "method": "getById", + "httpMethod": "get", + "tag": "Legacy Forms", + "typeScriptTag": "legacyForms", + "description": "Get Legacy Form by ID.", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/gdpr-fields/{gdprFieldId}", + "method": "getDetails", + "httpMethod": "get", + "tag": "GDPR Fields", + "typeScriptTag": "gdprFields", + "description": "Get GDPR Field details", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/workflow/{workflowId}", + "method": "getById", + "httpMethod": "get", + "tag": "Workflows", + "typeScriptTag": "workflows", + "description": "Get workflow by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/workflow/{workflowId}", + "method": "updateSingleWorkflow", + "httpMethod": "post", + "tag": "Workflows", + "typeScriptTag": "workflows", + "description": "Update workflow", + "parameters": [ + { + "name": "status", + "schema": "string", + "required": true, + "description": "", + "example": "active" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/sms/{smsId}", + "method": "getById", + "httpMethod": "get", + "tag": "SMS Messages", + "typeScriptTag": "smsMessages", + "description": "Get a single SMS message by its ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/autoresponders/{autoresponderId}", + "method": "deleteById", + "httpMethod": "delete", + "tag": "Autoresponders", + "typeScriptTag": "autoresponders", + "description": "Delete autoresponder.", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Delete autoresponder" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/autoresponders/{autoresponderId}", + "method": "getById", + "httpMethod": "get", + "tag": "Autoresponders", + "typeScriptTag": "autoresponders", + "description": "Get a single autoresponder by its ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/autoresponders/{autoresponderId}", + "method": "updateAutoresponder", + "httpMethod": "post", + "tag": "Autoresponders", + "typeScriptTag": "autoresponders", + "description": "Update autoresponder", + "parameters": [ + { + "name": "autoresponderId", + "schema": "string", + "required": true, + "description": "", + "example": "Q" + }, + { + "name": "href", + "schema": "string", + "required": true, + "description": "", + "example": "https://api.getresponse.com/v3/autoresponders/Q" + }, + { + "name": "name", + "schema": "string", + "required": false, + "description": "", + "example": "Message 2" + }, + { + "name": "subject", + "schema": "string", + "required": false, + "description": "", + "example": "test12" + }, + { + "name": "campaignId", + "schema": "string", + "required": false, + "description": "", + "example": "V" + }, + { + "name": "status", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "editor", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "fromField", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "replyTo", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "content", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "flags", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "sendSettings", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "triggerSettings", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "statistics", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "createdOn", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/autoresponders/{autoresponderId}/thumbnail", + "method": "getThumbnail", + "httpMethod": "get", + "tag": "Autoresponders", + "typeScriptTag": "autoresponders", + "description": "Get the autoresponder thumbnail", + "parameters": [ + { + "name": "size", + "schema": "string", + "required": false, + "description": "The size of the autoresponder thumbnail", + "default": "default" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/autoresponders/{autoresponderId}/statistics", + "method": "getStatistics", + "httpMethod": "get", + "tag": "Autoresponders", + "typeScriptTag": "autoresponders", + "description": "The statistics for a single autoresponder", + "parameters": [ + { + "name": "query[groupBy]", + "schema": "string", + "required": false, + "description": "Group results by time interval" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Count data from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Count data to this date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/websites/{websiteId}", + "method": "getById", + "httpMethod": "get", + "tag": "Websites", + "typeScriptTag": "websites", + "description": "Get a single Website by ID", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/statistics/wbe/{websiteId}/performance", + "method": "getPerformanceDetails", + "httpMethod": "get", + "tag": "Website", + "typeScriptTag": "website", + "description": "Get details for website statistics", + "parameters": [ + { + "name": "query[date][from]", + "schema": "undefined", + "required": false, + "description": "Show a single website statistics from this date" + }, + { + "name": "query[date][to]", + "schema": "undefined", + "required": false, + "description": "Show a single website statistics to this date" + }, + { + "name": "query[location]", + "schema": "string", + "required": false, + "description": "Website statistics by location" + }, + { + "name": "query[device]", + "schema": "string", + "required": false, + "description": "Website statistics by device" + }, + { + "name": "query[page]", + "schema": "string", + "required": false, + "description": "Website statistics by a page UUID" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/webinars", + "method": "getList", + "httpMethod": "get", + "tag": "Webinars", + "typeScriptTag": "webinars", + "description": "Get a list of webinars", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search webinars by name" + }, + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "The list of campaign resource IDs (string separated with ',')" + }, + { + "name": "query[status]", + "schema": "string", + "required": false, + "description": "Search webinars by status" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort webinars by name" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort webinars by creation date" + }, + { + "name": "sort[startsOn]", + "schema": "string", + "required": false, + "description": "Sort webinars by update date" + }, + { + "name": "query[type]", + "schema": "string", + "required": false, + "description": "Search webinars by type" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/contacts", + "method": "getList", + "httpMethod": "get", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Get contact list", + "parameters": [ + { + "name": "query[email]", + "schema": "string", + "required": false, + "description": "Search contacts by email" + }, + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search contacts by name" + }, + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "Search contacts by campaign ID" + }, + { + "name": "query[origin]", + "schema": "string", + "required": false, + "description": "Search contacts by origin" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Count data from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Count data to this date" + }, + { + "name": "query[changedOn][from]", + "schema": "undefined", + "required": false, + "description": "Search contacts edited from this date" + }, + { + "name": "query[changedOn][to]", + "schema": "undefined", + "required": false, + "description": "Search contacts edited to this date" + }, + { + "name": "sort[email]", + "schema": "string", + "required": false, + "description": "Sort by email" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "sort[changedOn]", + "schema": "string", + "required": false, + "description": "Sort by change date" + }, + { + "name": "sort[campaignId]", + "schema": "string", + "required": false, + "description": "Sort by campaign ID" + }, + { + "name": "additionalFlags", + "schema": "string", + "required": false, + "description": "The additional flags parameter with the value 'exactMatch' will search for contacts with the exact value of the email and name provided in the query string. Without this flag, matching is done via a standard 'like' comparison, which may sometimes be slow." + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/contacts", + "method": "createNewContact", + "httpMethod": "post", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Create a new contact", + "parameters": [], + "responses": [ + { + "statusCode": "202", + "description": ">\nIf the request is successful, the API returns the HTTP code **202 Accepted**.\nThis means that the contact has been preliminarily validated and added to the queue. \nIt may take a few minutes to process the queue and add the contact to the list. If your contact didn't appear on the list, there's a possibility that it was rejected at a later stage of processing. \n\n### Double opt-in\n\nCampaigns can be set to double opt-in.\nThis means that the contact has to click a link in a confirmation message before they can be added to your list.\nUnconfirmed contacts are not returned by the API and can only be found using Search Contacts." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/contacts/batch", + "method": "createBatchContacts", + "httpMethod": "post", + "tag": "Contacts", + "typeScriptTag": "contacts", + "description": "Create multiple contacts at once", + "parameters": [ + { + "name": "campaignId", + "schema": "string", + "required": true, + "description": "", + "example": "C" + }, + { + "name": "contacts", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "202", + "description": ">\nIf the request is successful, the API returns the HTTP code **202 Accepted**.\nThis means that the contacts has been preliminarily validated and added to the queue. \nIt may take a few minutes to process the queue and add the contacts to the list. If your contact doesn't appear on the list, they were likely rejected during the late processing stages. \n\n### Double opt-in\n\nCampaigns (https://apireference.getresponse.com/ can be set to use double opt-in.\nThis means that a contact has to click a link in a confirmation message before they can be added to your list.\nUnconfirmed contacts are not returned by API and can only be found using Search Contacts." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/search-contacts", + "method": "savedList", + "httpMethod": "get", + "tag": "Search Contacts", + "typeScriptTag": "searchContacts", + "description": "Get a saved search contact list", + "parameters": [ + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name", + "example": "desc" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by creation date", + "example": "asc" + }, + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search by name" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Count data from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Count data to this date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/search-contacts", + "method": "createNewSearch", + "httpMethod": "post", + "tag": "Search Contacts", + "typeScriptTag": "searchContacts", + "description": "Create search contacts", + "parameters": [], + "responses": [ + { + "statusCode": "201", + "description": "Search contact details." + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/search-contacts/contacts", + "method": "usingConditions", + "httpMethod": "post", + "tag": "Search Contacts", + "typeScriptTag": "searchContacts", + "description": "Search contacts using conditions", + "parameters": [ + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name", + "example": "desc" + }, + { + "name": "sort[email]", + "schema": "string", + "required": false, + "description": "Sort by email", + "example": "desc" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by creation date", + "example": "asc" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + }, + { + "name": "subscribersType", + "schema": "array", + "required": true, + "description": "" + }, + { + "name": "sectionLogicOperator", + "schema": "string", + "required": true, + "description": "", + "example": "or" + }, + { + "name": "section", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/transactional-emails/templates", + "method": "getList", + "httpMethod": "get", + "tag": "Transactional Emails Templates", + "typeScriptTag": "transactionalEmailsTemplates", + "description": "Get the list of transactional email templates", + "parameters": [ + { + "name": "query[subject]", + "schema": "string", + "required": false, + "description": "Search templates by subject" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by creation date" + }, + { + "name": "sort[subject]", + "schema": "string", + "required": false, + "description": "Sort by template subject" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/transactional-emails/templates", + "method": "createNewTemplate", + "httpMethod": "post", + "tag": "Transactional Emails Templates", + "typeScriptTag": "transactionalEmailsTemplates", + "description": "Create transactional email template", + "parameters": [ + { + "name": "subject", + "schema": "string", + "required": true, + "description": "", + "example": "Order Confirmation - Example Shop" + }, + { + "name": "content", + "schema": "object", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/transactional-emails", + "method": "getList", + "httpMethod": "get", + "tag": "Transactional Emails", + "typeScriptTag": "transactionalEmails", + "description": "Get the list of transactional emails", + "parameters": [ + { + "name": "query[sentOn][from]", + "schema": "undefined", + "required": false, + "description": "Search transactional emails sent from this date" + }, + { + "name": "query[sentOn][to]", + "schema": "undefined", + "required": false, + "description": "Search transactional emails sent to this date" + }, + { + "name": "query[tagged]", + "schema": "string", + "required": false, + "description": "Search tagged/untagged transactional emails" + }, + { + "name": "query[tagId]", + "schema": "string", + "required": false, + "description": "Search transactional emails with a specific tag ID" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/transactional-emails", + "method": "sendEmail", + "httpMethod": "post", + "tag": "Transactional Emails", + "typeScriptTag": "transactionalEmails", + "description": "Send transactional email", + "parameters": [ + { + "name": "fromField", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "replyTo", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "tag", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "recipients", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "contentType", + "schema": "string", + "required": true, + "description": "", + "example": "CONTENTTYPE", + "default": "direct" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/transactional-emails/statistics", + "method": "getOverallStatistics", + "httpMethod": "get", + "tag": "Transactional Emails", + "typeScriptTag": "transactionalEmails", + "description": "Get the overall statistics of transactional emails", + "parameters": [ + { + "name": "query[groupBy]", + "schema": "string", + "required": true, + "description": "Group results by time interval", + "example": "QUERY[GROUPBY]" + }, + { + "name": "query[timeFrame][from]", + "schema": "undefined", + "required": false, + "description": "Count data from this date" + }, + { + "name": "query[timeFrame][to]", + "schema": "undefined", + "required": false, + "description": "Count data to this date" + }, + { + "name": "query[tagged]", + "schema": "string", + "required": false, + "description": "Search tagged/untagged transactional emails" + }, + { + "name": "query[tagId]", + "schema": "string", + "required": false, + "description": "Search transactional emails with a specific tag ID" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/from-fields", + "method": "getList", + "httpMethod": "get", + "tag": "From Fields", + "typeScriptTag": "fromFields", + "description": "Get the list of 'From' addresses", + "parameters": [ + { + "name": "query[email]", + "schema": "string", + "required": false, + "description": "Search 'From' address by email" + }, + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search 'From' address by name" + }, + { + "name": "query[isDefault]", + "schema": "boolean", + "required": false, + "description": "Search only default 'From' address", + "example": true + }, + { + "name": "query[isActive]", + "schema": "boolean", + "required": false, + "description": "Search only active 'From' addresses", + "example": true + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort 'From' address by date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/from-fields", + "method": "createNewAddress", + "httpMethod": "post", + "tag": "From Fields", + "typeScriptTag": "fromFields", + "description": "Create 'From' address", + "parameters": [ + { + "name": "fromFieldId", + "schema": "string", + "description": "", + "example": "TTzW" + }, + { + "name": "href", + "schema": "string", + "description": "", + "example": "https://api.getresponse.com/v3/from-fields/TTzW" + }, + { + "name": "email", + "schema": "string", + "description": "", + "example": "jsmith@example.com" + }, + { + "name": "rewrittenEmail", + "schema": "string", + "description": "", + "example": "jsmith@example.com" + }, + { + "name": "name", + "schema": "string", + "description": "", + "example": "John Smith" + }, + { + "name": "isActive", + "schema": "string", + "description": "" + }, + { + "name": "isDefault", + "schema": "string", + "description": "" + }, + { + "name": "createdOn", + "schema": "string", + "description": "" + }, + { + "name": "domain", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/rss-newsletters", + "method": "getList", + "httpMethod": "get", + "tag": "RSS Newsletters", + "typeScriptTag": "rssNewsletters", + "description": "Get the list of RSS newsletters", + "parameters": [ + { + "name": "query[subject]", + "schema": "string", + "required": false, + "description": "Search RSS newsletters by subject" + }, + { + "name": "query[status]", + "schema": "string", + "required": false, + "description": "Search RSS newsletters by status" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Search RSS newsletters created from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Search RSS newsletters created to this date" + }, + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "Search RSS newsletters by campaign ID" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/rss-newsletters", + "method": "createNewsletter", + "httpMethod": "post", + "tag": "RSS Newsletters", + "typeScriptTag": "rssNewsletters", + "description": "Create RSS newsletter", + "parameters": [ + { + "name": "rssNewsletterId", + "schema": "string", + "required": true, + "description": "", + "example": "dGer" + }, + { + "name": "href", + "schema": "string", + "required": true, + "description": "", + "example": "https://api.getresponse.com/v3/rss-newsletters/dGer" + }, + { + "name": "rssFeedUrl", + "schema": "string", + "required": false, + "description": "", + "example": "http://blog.getresponse.com" + }, + { + "name": "subject", + "schema": "string", + "required": false, + "description": "", + "example": "My rss to newsletters" + }, + { + "name": "name", + "schema": "string", + "required": false, + "description": "", + "example": "rsstest0" + }, + { + "name": "status", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "editor", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "fromField", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "replyTo", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "content", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "sendSettings", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "createdOn", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/rss-newsletters/statistics", + "method": "getStatistics", + "httpMethod": "get", + "tag": "RSS Newsletters", + "typeScriptTag": "rssNewsletters", + "description": "The statistics for all RSS newsletters", + "parameters": [ + { + "name": "query[groupBy]", + "schema": "string", + "required": false, + "description": "Group results by time interval" + }, + { + "name": "query[rssNewsletterId]", + "schema": "string", + "required": false, + "description": "The list of RSS newsletter resource IDs (string separated with ',')" + }, + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "The list of campaign resource IDs (string separated with ',')" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Count data from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Count data to this date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/custom-events", + "method": "getList", + "httpMethod": "get", + "tag": "Custom Events", + "typeScriptTag": "customEvents", + "description": "Get a list of custom events", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search custom events by name" + }, + { + "name": "query[hasAttributes]", + "schema": "string", + "required": false, + "description": "Search custom events with or without attributes" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/custom-events", + "method": "createEvent", + "httpMethod": "post", + "tag": "Custom Events", + "typeScriptTag": "customEvents", + "description": "Create custom event", + "parameters": [ + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "sample_custom_event" + }, + { + "name": "attributes", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/custom-events/trigger", + "method": "triggerEvent", + "httpMethod": "post", + "tag": "Custom Events", + "typeScriptTag": "customEvents", + "description": "Trigger a custom event", + "parameters": [ + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "lesson_finished" + }, + { + "name": "contactId", + "schema": "string", + "required": true, + "description": "", + "example": "lTgH5" + }, + { + "name": "attributes", + "schema": "array", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "Empty response" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/forms", + "method": "getList", + "httpMethod": "get", + "tag": "Forms", + "typeScriptTag": "forms", + "description": "Get the list of forms.", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search forms by name" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Search forms created from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Search forms created to this date" + }, + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "Search forms assigned to this list (https://apireference.getresponse.com/. You can pass multiple comma-separated values, eg. `Xd1P,sC7r`" + }, + { + "name": "query[status]", + "schema": "string", + "required": false, + "description": "Search by status. **Note:** `disabled` includes both `unpublished` and `draft` and `enabled` equals `published`" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "sort[visitors]", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "sort[uniqueVisitors]", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "sort[subscribed]", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "sort[subscriptionRate]", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/landing-pages", + "method": "getList", + "httpMethod": "get", + "tag": "Legacy Landing Pages", + "typeScriptTag": "legacyLandingPages", + "description": "Get a list of landing pages", + "parameters": [ + { + "name": "query[domain]", + "schema": "string", + "required": false, + "description": "Search landing pages by domain" + }, + { + "name": "query[status]", + "schema": "string", + "required": false, + "description": "Search landing pages by status" + }, + { + "name": "query[subdomain]", + "schema": "string", + "required": false, + "description": "Search landing pages by subdomain" + }, + { + "name": "query[metaTitle]", + "schema": "string", + "required": false, + "description": "Search landing pages by metaTitle field" + }, + { + "name": "query[userDomain]", + "schema": "string", + "required": false, + "description": "Search landing pages by user provided domain" + }, + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "Search landing pages by ID of the assigned campaign. Campaign ID must be encoded! You can get the campaign list with encoded IDs by calling the `/v3/campaigns` endpoint. You can search by multiple comma separated values eg. `o5lx,34er`." + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Show landing pages created from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Show landing pages created to this date" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "sort[domain]", + "schema": "string", + "required": false, + "description": "Sort by domain" + }, + { + "name": "sort[campaignId]", + "schema": "string", + "required": false, + "description": "Sort by campaign" + }, + { + "name": "sort[metaTitle]", + "schema": "string", + "required": false, + "description": "Sort by metaTitle" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/imports", + "method": "getList", + "httpMethod": "get", + "tag": "Imports", + "typeScriptTag": "imports", + "description": "Get a list of imports.", + "parameters": [ + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "Search imports by campaignId" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Search imports created from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Search imports created to this date" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort imports by creation date" + }, + { + "name": "sort[finishedOn]", + "schema": "string", + "required": false, + "description": "Sort imports by finish date" + }, + { + "name": "sort[campaignName]", + "schema": "string", + "required": false, + "description": "Sort imports by campaign name" + }, + { + "name": "sort[uploadedContacts]", + "schema": "string", + "required": false, + "description": "Sort imports by uploaded contact count" + }, + { + "name": "sort[updatedContacts]", + "schema": "string", + "required": false, + "description": "Sort imports by updated contact count" + }, + { + "name": "sort[addedContacts]", + "schema": "string", + "required": false, + "description": "Sort imports by inserted contact count" + }, + { + "name": "sort[invalidContacts]", + "schema": "string", + "required": false, + "description": "Sort imports by invalid contact count" + }, + { + "name": "sort[status]", + "schema": "string", + "required": false, + "description": "Sort imports by status (uploaded, to_review, approved, finished, rejected, canceled)" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/imports", + "method": "scheduleNewContactImport", + "httpMethod": "post", + "tag": "Imports", + "typeScriptTag": "imports", + "description": "Schedule a new contact import", + "parameters": [ + { + "name": "campaignId", + "schema": "string", + "required": true, + "description": "", + "example": "z5c" + }, + { + "name": "fieldMapping", + "schema": "array", + "required": true, + "description": "" + }, + { + "name": "contacts", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/statistics/ecommerce/revenue", + "method": "getRevenueStatistics", + "httpMethod": "get", + "tag": "Ecommerce", + "typeScriptTag": "ecommerce", + "description": "Get the ecommerce revenue statistics", + "parameters": [ + { + "name": "query[orderDate][from]", + "schema": "string", + "required": false, + "description": "Show statistics for orders from this date" + }, + { + "name": "query[orderDate][to]", + "schema": "string", + "required": false, + "description": "Show statistics for orders to this date" + }, + { + "name": "query[shopId]", + "schema": "string", + "required": false, + "description": "Search statistics by shop ID. You can get the shop ID by calling the `/v3/shops` endpoint. You can search for multiple shops using comma-separated values, for example, `pgIH, CNXF`" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/statistics/ecommerce/performance", + "method": "getPerformanceStatistics", + "httpMethod": "get", + "tag": "Ecommerce", + "typeScriptTag": "ecommerce", + "description": "Get the ecommerce general performance statistics", + "parameters": [ + { + "name": "query[orderDate][from]", + "schema": "string", + "required": false, + "description": "Show statistics for orders from this date" + }, + { + "name": "query[orderDate][to]", + "schema": "string", + "required": false, + "description": "Show statistics for orders to this date" + }, + { + "name": "query[shopId]", + "schema": "string", + "required": false, + "description": "Search statistics by shop ID. You can get the shop ID by calling the `/v3/shops` endpoint. You can search for multiple shops using comma-separated values, for example, `pgIH, CNXF`" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/predefined-fields", + "method": "getList", + "httpMethod": "get", + "tag": "Predefined Fields", + "typeScriptTag": "predefinedFields", + "description": "Get the predefined fields list", + "parameters": [ + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name", + "example": "DESC" + }, + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search by name" + }, + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "Search by campaign ID" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/predefined-fields", + "method": "createField", + "httpMethod": "post", + "tag": "Predefined Fields", + "typeScriptTag": "predefinedFields", + "description": "Create a predefined field", + "parameters": [ + { + "name": "predefinedFieldId", + "schema": "string", + "description": "", + "example": "6neM" + }, + { + "name": "href", + "schema": "string", + "description": "", + "example": "https://api.getresponse.com/v3/predefined-fields/6neM" + }, + { + "name": "name", + "schema": "string", + "description": "", + "example": "my_predefined_field_123" + }, + { + "name": "value", + "schema": "string", + "description": "", + "example": "my value" + }, + { + "name": "campaign", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/suppressions", + "method": "getSuppressionLists", + "httpMethod": "get", + "tag": "Suppressions", + "typeScriptTag": "suppressions", + "description": "Get suppression lists", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search suppressions by name" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Search suppressions created from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Search suppressions created to this date" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by the createdOn date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/suppressions", + "method": "createNewSuppressionList", + "httpMethod": "post", + "tag": "Suppressions", + "typeScriptTag": "suppressions", + "description": "Creates a new suppression list", + "parameters": [ + { + "name": "name", + "schema": "string", + "description": "", + "example": "suppression-name" + }, + { + "name": "masks", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/subscription-confirmations/body/{languageCode}", + "method": "getCollectionOfBodies", + "httpMethod": "get", + "tag": "Subscription Confirmations", + "typeScriptTag": "subscriptionConfirmations", + "description": "Get collection of SUBSCRIPTION CONFIRMATIONS bodies", + "parameters": [ + { + "name": "languageCode", + "schema": "string", + "required": true, + "description": "ISO 639-1 Language Code Standard", + "example": "en" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/subscription-confirmations/subject/{languageCode}", + "method": "getSubjectCollection", + "httpMethod": "get", + "tag": "Subscription Confirmations", + "typeScriptTag": "subscriptionConfirmations", + "description": "Get collection of SUBSCRIPTION CONFIRMATIONS subjects", + "parameters": [ + { + "name": "languageCode", + "schema": "string", + "required": true, + "description": "ISO 639-1 Language Code Standard", + "example": "en" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops", + "method": "getListOfShops", + "httpMethod": "get", + "tag": "Shops", + "typeScriptTag": "shops", + "description": "Get a list of shops", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search shop by name" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/shops", + "method": "createNewShop", + "httpMethod": "post", + "tag": "Shops", + "typeScriptTag": "shops", + "description": "Create shop", + "parameters": [ + { + "name": "createdOn", + "schema": "string", + "description": "" + }, + { + "name": "updatedOn", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/popups", + "method": "getList", + "httpMethod": "get", + "tag": "Forms and Popups", + "typeScriptTag": "formsAndPopups", + "description": "Get the list of forms and popups", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search forms and popups by name" + }, + { + "name": "query[status]", + "schema": "string", + "required": false, + "description": "Search forms and popups by status" + }, + { + "name": "stats[from]", + "schema": "string", + "required": false, + "description": "Show statistics from this date" + }, + { + "name": "stats[to]", + "schema": "string", + "required": false, + "description": "Show statistics to this date" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort forms and popups by name" + }, + { + "name": "sort[status]", + "schema": "string", + "required": false, + "description": "Sort forms and popups by status" + }, + { + "name": "sort[createdAt]", + "schema": "string", + "required": false, + "description": "Sort forms and popups by creation date" + }, + { + "name": "sort[updatedAt]", + "schema": "string", + "required": false, + "description": "Sort forms and popups by modification date" + }, + { + "name": "sort[views]", + "schema": "string", + "required": false, + "description": "Sort by number of views" + }, + { + "name": "sort[uniqueVisitors]", + "schema": "string", + "required": false, + "description": "Sort by number of unique visitors" + }, + { + "name": "sort[leads]", + "schema": "string", + "required": false, + "description": "Sort by number of leads" + }, + { + "name": "sort[ctr]", + "schema": "string", + "required": false, + "description": "Sort by CTR (click-through rate)" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/splittests", + "method": "getList", + "httpMethod": "get", + "tag": "A/B tests", + "typeScriptTag": "aBTests", + "description": "The list of A/B tests.", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search A/B tests by name" + }, + { + "name": "query[type]", + "schema": "string", + "required": false, + "description": "Search A/B tests by type" + }, + { + "name": "query[status]", + "schema": "string", + "required": false, + "description": "Search A/B tests by status", + "default": "active" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Search A/B tests created from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Search A/B tests created to this date" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by creation date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/file-library/quota", + "method": "getStorageInfo", + "httpMethod": "get", + "tag": "File Library", + "typeScriptTag": "fileLibrary", + "description": "Get storage space information", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/file-library/files", + "method": "getFileList", + "httpMethod": "get", + "tag": "File Library", + "typeScriptTag": "fileLibrary", + "description": "Get the list of files", + "parameters": [ + { + "name": "query[allFolders]", + "schema": "string", + "required": false, + "description": "Return files from all folders, including the root folder. **This parameter can't be used together with ** `query[folderId]`" + }, + { + "name": "query[folderId]", + "schema": "string", + "required": false, + "description": "Search for files in a specific folder. **This parameter can't be used together with ** `query[allFolders]`" + }, + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search for files by name" + }, + { + "name": "query[group]", + "schema": "string", + "required": false, + "description": "Search for files by group", + "example": "photo" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name" + }, + { + "name": "sort[group]", + "schema": "string", + "required": false, + "description": "Sort files by group" + }, + { + "name": "sort[size]", + "schema": "string", + "required": false, + "description": "Sort files by size" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/file-library/files", + "method": "createNewFile", + "httpMethod": "post", + "tag": "File Library", + "typeScriptTag": "fileLibrary", + "description": "Create a file", + "parameters": [ + { + "name": "name", + "schema": "string", + "description": "", + "example": "image" + }, + { + "name": "extension", + "schema": "string", + "description": "", + "example": "jpg" + }, + { + "name": "folder", + "schema": "undefined", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/file-library/folders", + "method": "listFolders", + "httpMethod": "get", + "tag": "File Library", + "typeScriptTag": "fileLibrary", + "description": "Get the list of folders", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search folders by name" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort folders by name" + }, + { + "name": "sort[size]", + "schema": "string", + "required": false, + "description": "Sort folders by size" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort folders by creation date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/file-library/folders", + "method": "createFolder", + "httpMethod": "post", + "tag": "File Library", + "typeScriptTag": "fileLibrary", + "description": "Create a folder", + "parameters": [ + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "sample folder" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/ab-tests/subject", + "method": "getList", + "httpMethod": "get", + "tag": "A/B tests - subject", + "typeScriptTag": "aBTestsSubject", + "description": "The list of A/B tests", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search A/B tests by name" + }, + { + "name": "query[stage]", + "schema": "string", + "required": false, + "description": "Search A/B tests by stage" + }, + { + "name": "query[abTestId]", + "schema": "string", + "required": false, + "description": "Search A/B tests by ID" + }, + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "Search A/B tests by list ID" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name" + }, + { + "name": "sort[stage]", + "schema": "string", + "required": false, + "description": "Sort by stage" + }, + { + "name": "sort[sendOn]", + "schema": "string", + "required": false, + "description": "Sort by send date" + }, + { + "name": "sort[totalDelivered]", + "schema": "string", + "required": false, + "description": "Sort by total delivered" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/ab-tests/subject", + "method": "createNewTest", + "httpMethod": "post", + "tag": "A/B tests - subject", + "typeScriptTag": "aBTestsSubject", + "description": "Create a new A/B test", + "parameters": [], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/click-tracks", + "method": "getList", + "httpMethod": "get", + "tag": "Click Tracks", + "typeScriptTag": "clickTracks", + "description": "Get click tracked links list", + "parameters": [ + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Search click tracks from messages created from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Search click tracks from messages created to this date" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by message date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/newsletters", + "method": "getList", + "httpMethod": "get", + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "Get the newsletter list", + "parameters": [ + { + "name": "query[subject]", + "schema": "string", + "required": false, + "description": "Search newsletters by subject" + }, + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search newsletters by name" + }, + { + "name": "query[status]", + "schema": "string", + "required": false, + "description": "Search newsletters by status" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Search newsletters created from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Search newsletters created to this date" + }, + { + "name": "query[sendOn][from]", + "schema": "string", + "required": false, + "description": "Search for newsletters sent from this date", + "example": "2023-01-20" + }, + { + "name": "query[sendOn][to]", + "schema": "string", + "required": false, + "description": "Search for newsletters sent to this date", + "example": "2023-01-20" + }, + { + "name": "query[type]", + "schema": "string", + "required": false, + "description": "Search newsletters by type" + }, + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "Search newsletters by campaign ID" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "sort[sendOn]", + "schema": "string", + "required": false, + "description": "Sort by send on date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/newsletters", + "method": "enqueueNewsletter", + "httpMethod": "post", + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "Create newsletter", + "parameters": [ + { + "name": "content", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "flags", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "name", + "schema": "string", + "required": false, + "description": "", + "example": "New message" + }, + { + "name": "type", + "schema": "string", + "required": false, + "description": "", + "default": "broadcast" + }, + { + "name": "editor", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "subject", + "schema": "string", + "required": true, + "description": "", + "example": "Annual report" + }, + { + "name": "fromField", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "replyTo", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "campaign", + "schema": "object", + "required": true, + "description": "" + }, + { + "name": "sendOn", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "attachments", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "sendSettings", + "schema": "object", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/newsletters/send-draft", + "method": "sendDraft", + "httpMethod": "post", + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "Send the newsletter draft", + "parameters": [ + { + "name": "messageId", + "schema": "string", + "required": true, + "description": "", + "example": "N" + }, + { + "name": "sendOn", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "sendSettings", + "schema": "object", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/newsletters/statistics", + "method": "getStatisticsBasedOnList", + "httpMethod": "get", + "tag": "Newsletters", + "typeScriptTag": "newsletters", + "description": "Total newsletter statistics", + "parameters": [ + { + "name": "query[groupBy]", + "schema": "string", + "required": false, + "description": "Group results by time interval" + }, + { + "name": "query[newsletterId]", + "schema": "string", + "required": false, + "description": "The list of newsletter resource IDs (string separated with '')" + }, + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "The list of campaign resource IDs (string separated with '')" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Count data from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Count data to this date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/tags", + "method": "getList", + "httpMethod": "get", + "tag": "Tags", + "typeScriptTag": "tags", + "description": "Get the list of tags", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search tags by name" + }, + { + "name": "query[createdAt][from]", + "schema": "undefined", + "required": false, + "description": "Search tags created from this date" + }, + { + "name": "query[createdAt][to]", + "schema": "undefined", + "required": false, + "description": "Search tags created to this date" + }, + { + "name": "sort[createdAt]", + "schema": "string", + "required": false, + "description": "Sort tags by creation date" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/tags", + "method": "addNewTag", + "httpMethod": "post", + "tag": "Tags", + "typeScriptTag": "tags", + "description": "Add a new tag", + "parameters": [ + { + "name": "name", + "schema": "string", + "description": "", + "example": "My_Tag" + }, + { + "name": "color", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/addresses", + "method": "getList", + "httpMethod": "get", + "tag": "Addresses", + "typeScriptTag": "addresses", + "description": "Get a list of addresses", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search addresses by name" + }, + { + "name": "query[firstName]", + "schema": "string", + "required": false, + "description": "Search addresses by first name" + }, + { + "name": "query[lastName]", + "schema": "string", + "required": false, + "description": "Search addresses by last name" + }, + { + "name": "query[address1]", + "schema": "string", + "required": false, + "description": "Search addresses by address1 field" + }, + { + "name": "query[address2]", + "schema": "string", + "required": false, + "description": "Search addresses by address2 field" + }, + { + "name": "query[city]", + "schema": "string", + "required": false, + "description": "Search addresses by city" + }, + { + "name": "query[zip]", + "schema": "string", + "required": false, + "description": "Search addresses by ZIP" + }, + { + "name": "query[province]", + "schema": "string", + "required": false, + "description": "Search addresses by province" + }, + { + "name": "query[provinceCode]", + "schema": "string", + "required": false, + "description": "Search addresses by province code" + }, + { + "name": "query[phone]", + "schema": "string", + "required": false, + "description": "Search addresses by phone" + }, + { + "name": "query[company]", + "schema": "string", + "required": false, + "description": "Search addresses by company" + }, + { + "name": "query[createdOn][from]", + "schema": "string", + "required": false, + "description": "Search addresses created from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "string", + "required": false, + "description": "Search addresses created to this date" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/addresses", + "method": "createNewAddress", + "httpMethod": "post", + "tag": "Addresses", + "typeScriptTag": "addresses", + "description": "Create address", + "parameters": [ + { + "name": "createdOn", + "schema": "string", + "description": "" + }, + { + "name": "updatedOn", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/accounts/blocklists", + "method": "getBlocklistMasks", + "httpMethod": "get", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Returns account blocklist masks", + "parameters": [ + { + "name": "query[mask]", + "schema": "string", + "required": false, + "description": "Blocklist mask to search for", + "example": "@somedomain.com" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/accounts/blocklists", + "method": "updateBlocklist", + "httpMethod": "post", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Update account blocklist", + "parameters": [ + { + "name": "additionalFlags", + "schema": "string", + "required": false, + "description": "The flag value `add` adds the masks provided in the request body to your blocklist. The flag value `delete` deletes the masks. The masks are replaced if there are no flag values in the request body. \n\n For better performance, use the flag value `noResponse`. It removes the response body and can be used alone or combined with other flags. If multiple flags are used, separate them by a comma, like this: `additionalFlags=noResponse` or `additionalFlags=add,noResponse`." + }, + { + "name": "masks", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/custom-fields", + "method": "getList", + "httpMethod": "get", + "tag": "Custom Fields", + "typeScriptTag": "customFields", + "description": "Get a list of custom fields", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search custom fields by name" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/custom-fields", + "method": "createNewField", + "httpMethod": "post", + "tag": "Custom Fields", + "typeScriptTag": "customFields", + "description": "Create a custom field", + "parameters": [ + { + "name": "customFieldId", + "schema": "string", + "description": "", + "example": "pas" + }, + { + "name": "href", + "schema": "string", + "description": "", + "example": "https://api.getresponse.com/v3/custom-fields/pas" + }, + { + "name": "name", + "schema": "string", + "description": "", + "example": "office_phone_number" + }, + { + "name": "type", + "schema": "string", + "description": "" + }, + { + "name": "valueType", + "schema": "string", + "description": "", + "example": "phone" + }, + { + "name": "format", + "schema": "string", + "description": "" + }, + { + "name": "fieldType", + "schema": "string", + "description": "", + "example": "text" + }, + { + "name": "hidden", + "schema": "string", + "description": "" + }, + { + "name": "values", + "schema": "array", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/lps", + "method": "getList", + "httpMethod": "get", + "tag": "Landing Pages", + "typeScriptTag": "landingPages", + "description": "Get the list of landing pages", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search landing pages by name" + }, + { + "name": "query[status]", + "schema": "string", + "required": false, + "description": "Search landing pages by status" + }, + { + "name": "stats[from]", + "schema": "string", + "required": false, + "description": "Show statistics for landing pages from this date" + }, + { + "name": "stats[to]", + "schema": "string", + "required": false, + "description": "Show statistics for landing pages to this date" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort landing pages by name" + }, + { + "name": "sort[createdAt]", + "schema": "string", + "required": false, + "description": "Sort landing pages by creation date" + }, + { + "name": "sort[updatedAt]", + "schema": "string", + "required": false, + "description": "Sort landing pages by modification date" + }, + { + "name": "sort[visits]", + "schema": "string", + "required": false, + "description": "Sort by number of page visits" + }, + { + "name": "sort[leads]", + "schema": "string", + "required": false, + "description": "Sort landing pages by number of leads" + }, + { + "name": "sort[subscriptionRate]", + "schema": "string", + "required": false, + "description": "Sort by subscription rate" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/multimedia", + "method": "getImageList", + "httpMethod": "get", + "tag": "Multimedia", + "typeScriptTag": "multimedia", + "description": "Get images list", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/multimedia", + "method": "uploadImage", + "httpMethod": "post", + "tag": "Multimedia", + "typeScriptTag": "multimedia", + "description": "Upload image", + "parameters": [ + { + "name": "file", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/tracking", + "method": "javascriptCodeSnippets", + "httpMethod": "get", + "tag": "Tracking", + "typeScriptTag": "tracking", + "description": "Get Tracking JavaScript code snippets", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/tracking/facebook-pixels", + "method": "getFacebookPixels", + "httpMethod": "get", + "tag": "Tracking", + "typeScriptTag": "tracking", + "description": "Get the list of \"Facebook Pixels\"", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/accounts", + "method": "getInformation", + "httpMethod": "get", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Account information", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/accounts", + "method": "updateAccountDetails", + "httpMethod": "post", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Update account", + "parameters": [ + { + "name": "accountId", + "schema": "string", + "description": "", + "example": "VfEy1" + }, + { + "name": "email", + "schema": "string", + "description": "", + "example": "john.smith@test.com" + }, + { + "name": "countryCode", + "schema": "object", + "description": "" + }, + { + "name": "industryTag", + "schema": "object", + "description": "" + }, + { + "name": "timeZone", + "schema": "undefined", + "description": "" + }, + { + "name": "href", + "schema": "string", + "description": "", + "example": "https://api.getresponse.com/v3/accounts" + }, + { + "name": "firstName", + "schema": "string", + "description": "", + "example": "John" + }, + { + "name": "lastName", + "schema": "string", + "description": "", + "example": "Smith" + }, + { + "name": "companyName", + "schema": "string", + "description": "", + "example": "MyBigCompany" + }, + { + "name": "phone", + "schema": "string", + "description": "", + "example": "+00155555555" + }, + { + "name": "state", + "schema": "string", + "description": "", + "example": "Oklahoma" + }, + { + "name": "city", + "schema": "string", + "description": "", + "example": "Alderson" + }, + { + "name": "street", + "schema": "string", + "description": "", + "example": "Sunset blv." + }, + { + "name": "zipCode", + "schema": "string", + "description": "", + "example": "81-611" + }, + { + "name": "numberOfEmployees", + "schema": "string", + "description": "", + "example": "500" + }, + { + "name": "timeFormat", + "schema": "string", + "description": "", + "example": "24h" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/accounts/billing", + "method": "getBillingInformation", + "httpMethod": "get", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Billing information", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/accounts/login-history", + "method": "getLoginHistory", + "httpMethod": "get", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "History of logins", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/accounts/badge", + "method": "getCurrentStatusOfBadge", + "httpMethod": "get", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Current status of your GetResponse badge", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/accounts/badge", + "method": "toggleBadgeStatus", + "httpMethod": "post", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Turn on/off the GetResponse Badge", + "parameters": [ + { + "name": "status", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/accounts/industries", + "method": "listIndustryTags", + "httpMethod": "get", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "List of Industry Tags", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/accounts/timezones", + "method": "getTimezonesList", + "httpMethod": "get", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "List of timezones", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/accounts/callbacks", + "method": "disableCallbacks", + "httpMethod": "delete", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Disable callbacks", + "parameters": [], + "responses": [ + { + "statusCode": "204", + "description": "Empty response" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/accounts/callbacks", + "method": "getConfiguration", + "httpMethod": "get", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Get callbacks configuration", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/accounts/callbacks", + "method": "enableCallbacksConfiguration", + "httpMethod": "post", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Enable or update callbacks configuration", + "parameters": [ + { + "name": "url", + "schema": "string", + "description": "", + "example": "https://example.com/callback" + }, + { + "name": "actions", + "schema": "object", + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/accounts/sending-limits", + "method": "getSendingLimits", + "httpMethod": "get", + "tag": "Accounts", + "typeScriptTag": "accounts", + "description": "Send limits", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/campaigns", + "method": "getList", + "httpMethod": "get", + "tag": "Campaigns (https://apireference.getresponse.com/", + "typeScriptTag": "campaignsHttps:ApireferenceGetresponseCom", + "description": "Get a list of campaigns", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "", + "example": "campaign_name" + }, + { + "name": "query[isDefault]", + "schema": "boolean", + "required": false, + "description": "", + "example": true + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/campaigns", + "method": "createNewCampaign", + "httpMethod": "post", + "tag": "Campaigns (https://apireference.getresponse.com/", + "typeScriptTag": "campaignsHttps:ApireferenceGetresponseCom", + "description": "Create a campaign", + "parameters": [], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/campaigns/statistics/origins", + "method": "getSubscriberOriginStatistics", + "httpMethod": "get", + "tag": "Campaigns (https://apireference.getresponse.com/", + "typeScriptTag": "campaignsHttps:ApireferenceGetresponseCom", + "description": "Get subscriber origin statistics", + "parameters": [ + { + "name": "query[campaignId]", + "schema": "string", + "required": true, + "description": "", + "example": "3Va2e" + }, + { + "name": "query[groupBy]", + "schema": "string", + "required": false, + "description": "", + "example": "month" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/campaigns/statistics/locations", + "method": "getSubscriberLocationStatistics", + "httpMethod": "get", + "tag": "Campaigns (https://apireference.getresponse.com/", + "typeScriptTag": "campaignsHttps:ApireferenceGetresponseCom", + "description": "Get subscriber location statistics", + "parameters": [ + { + "name": "query[campaignId]", + "schema": "string", + "required": true, + "description": "", + "example": "3Va2e" + }, + { + "name": "query[groupBy]", + "schema": "string", + "required": false, + "description": "", + "example": "month" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/campaigns/statistics/list-size", + "method": "getCampaignSizeStatistics", + "httpMethod": "get", + "tag": "Campaigns (https://apireference.getresponse.com/", + "typeScriptTag": "campaignsHttps:ApireferenceGetresponseCom", + "description": "Get campaign size statistics", + "parameters": [ + { + "name": "query[campaignId]", + "schema": "string", + "required": true, + "description": "", + "example": "3Va2e" + }, + { + "name": "query[groupBy]", + "schema": "string", + "required": false, + "description": "", + "example": "month" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/campaigns/statistics/subscriptions", + "method": "getSubscriptionStatistics", + "httpMethod": "get", + "tag": "Campaigns (https://apireference.getresponse.com/", + "typeScriptTag": "campaignsHttps:ApireferenceGetresponseCom", + "description": "Get the number and origin of subscription statistics", + "parameters": [ + { + "name": "query[campaignId]", + "schema": "string", + "required": true, + "description": "", + "example": "3Va2e" + }, + { + "name": "query[groupBy]", + "schema": "string", + "required": false, + "description": "", + "example": "month" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/campaigns/statistics/removals", + "method": "getRemovalStatistics", + "httpMethod": "get", + "tag": "Campaigns (https://apireference.getresponse.com/", + "typeScriptTag": "campaignsHttps:ApireferenceGetresponseCom", + "description": "Get removal statistics", + "parameters": [ + { + "name": "query[campaignId]", + "schema": "string", + "required": true, + "description": "", + "example": "3Va2e" + }, + { + "name": "query[groupBy]", + "schema": "string", + "required": false, + "description": "", + "example": "month" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/campaigns/statistics/balance", + "method": "getBalanceStatistics", + "httpMethod": "get", + "tag": "Campaigns (https://apireference.getresponse.com/", + "typeScriptTag": "campaignsHttps:ApireferenceGetresponseCom", + "description": "Get balance statistics", + "parameters": [ + { + "name": "query[campaignId]", + "schema": "string", + "required": true, + "description": "", + "example": "3Va2e" + }, + { + "name": "query[groupBy]", + "schema": "string", + "required": false, + "description": "", + "example": "month" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/campaigns/statistics/summary", + "method": "getStatisticsSummary", + "httpMethod": "get", + "tag": "Campaigns (https://apireference.getresponse.com/", + "typeScriptTag": "campaignsHttps:ApireferenceGetresponseCom", + "description": "Get the statistics summary for selected campaigns", + "parameters": [ + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "", + "example": "3Va2e" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/webforms", + "method": "getList", + "httpMethod": "get", + "tag": "Legacy Forms", + "typeScriptTag": "legacyForms", + "description": "Get Legacy Forms.", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search Legacy Forms by name" + }, + { + "name": "query[modifiedOn][from]", + "schema": "string", + "required": false, + "description": "Search Legacy Forms modified from this date" + }, + { + "name": "query[modifiedOn][to]", + "schema": "string", + "required": false, + "description": "Search Legacy Forms modified to this date" + }, + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "Search Legacy Forms by campaignId. Accepts multiple IDs separated with a comma" + }, + { + "name": "sort[modifiedOn]", + "schema": "string", + "required": false, + "description": "Sort Legacy Forms by modification date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/gdpr-fields", + "method": "getList", + "httpMethod": "get", + "tag": "GDPR Fields", + "typeScriptTag": "gdprFields", + "description": "Get the GDPR fields list", + "parameters": [ + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort fields by name" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort fields by creation date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/workflow", + "method": "listWorkflows", + "httpMethod": "get", + "tag": "Workflows", + "typeScriptTag": "workflows", + "description": "Get workflows", + "parameters": [ + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/sms-automation", + "method": "getList", + "httpMethod": "get", + "tag": "SMS Automation Messages", + "typeScriptTag": "smsAutomationMessages", + "description": "Get the list of automated SMS messages.", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search automated SMS messages by name" + }, + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "Search automated SMS messages by campaign (https://apireference.getresponse.com/ ID" + }, + { + "name": "query[hasLinks]", + "schema": "boolean", + "required": false, + "description": "Search for automated SMS messages containing links" + }, + { + "name": "sort[status]", + "schema": "string", + "required": false, + "description": "Sort by the status of the SMS message" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by the name of the automated SMS message" + }, + { + "name": "sort[modifiedOn]", + "schema": "string", + "required": false, + "description": "Sort by the date the SMS message was modified on" + }, + { + "name": "sort[delivered]", + "schema": "string", + "required": false, + "description": "Sort by the number of delivered SMS messages" + }, + { + "name": "sort[sent]", + "schema": "string", + "required": false, + "description": "Sort by the number of sent SMS messages" + }, + { + "name": "sort[clicks]", + "schema": "string", + "required": false, + "description": "Sort by the number of link clicks" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/sms", + "method": "getList", + "httpMethod": "get", + "tag": "SMS Messages", + "typeScriptTag": "smsMessages", + "description": "Get the list of SMS messages.", + "parameters": [ + { + "name": "query[type]", + "schema": "string", + "required": false, + "description": "Search SMS messages by type" + }, + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search SMS messages by name" + }, + { + "name": "query[sendingStatus]", + "schema": "string", + "required": false, + "description": "Search SMS messages by status" + }, + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "Search SMS messages by campaign (https://apireference.getresponse.com/ ID" + }, + { + "name": "query[hasLinks]", + "schema": "boolean", + "required": false, + "description": "Search for SMS messages with links" + }, + { + "name": "sort[sendingStatus]", + "schema": "string", + "required": false, + "description": "Sort by sending status" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name" + }, + { + "name": "sort[sendOn]", + "schema": "string", + "required": false, + "description": "Sort by sending date" + }, + { + "name": "sort[modifiedOn]", + "schema": "string", + "required": false, + "description": "Sort by modification date" + }, + { + "name": "sort[delivered]", + "schema": "string", + "required": false, + "description": "Sort by number of delivered messages" + }, + { + "name": "sort[sent]", + "schema": "string", + "required": false, + "description": "Sort by number of sent messages" + }, + { + "name": "sort[clicks]", + "schema": "string", + "required": false, + "description": "Sort by number of link clicks" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/autoresponders", + "method": "getList", + "httpMethod": "get", + "tag": "Autoresponders", + "typeScriptTag": "autoresponders", + "description": "Get the list of autoresponders.", + "parameters": [ + { + "name": "query[subject]", + "schema": "string", + "required": false, + "description": "Search autoresponder by subject" + }, + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search autoresponder by name" + }, + { + "name": "query[status]", + "schema": "string", + "required": false, + "description": "Search autoresponder by status" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Search autoresponder created from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Search autoresponder created to this date" + }, + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "Search autoresponder by campaign ID" + }, + { + "name": "query[type]", + "schema": "string", + "required": false, + "description": "Search autoresponder by type" + }, + { + "name": "query[triggerType]", + "schema": "string", + "required": false, + "description": "Search autoresponder by triggerType" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort by name" + }, + { + "name": "sort[subject]", + "schema": "string", + "required": false, + "description": "Sort by subject" + }, + { + "name": "sort[dayOfCycle]", + "schema": "string", + "required": false, + "description": "Sort by cycle day" + }, + { + "name": "sort[delivered]", + "schema": "string", + "required": false, + "description": "Sort by delivered" + }, + { + "name": "sort[openRate]", + "schema": "string", + "required": false, + "description": "Sort by open rate" + }, + { + "name": "sort[clickRate]", + "schema": "string", + "required": false, + "description": "Sort by click rate" + }, + { + "name": "sort[createdOn]", + "schema": "string", + "required": false, + "description": "Sort by date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/autoresponders", + "method": "createNewAutoresponder", + "httpMethod": "post", + "tag": "Autoresponders", + "typeScriptTag": "autoresponders", + "description": "Create autoresponder", + "parameters": [ + { + "name": "autoresponderId", + "schema": "string", + "required": true, + "description": "", + "example": "Q" + }, + { + "name": "href", + "schema": "string", + "required": true, + "description": "", + "example": "https://api.getresponse.com/v3/autoresponders/Q" + }, + { + "name": "name", + "schema": "string", + "required": false, + "description": "", + "example": "Message 2" + }, + { + "name": "subject", + "schema": "string", + "required": false, + "description": "", + "example": "test12" + }, + { + "name": "campaignId", + "schema": "string", + "required": false, + "description": "", + "example": "V" + }, + { + "name": "status", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "editor", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "fromField", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "replyTo", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "content", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "flags", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "sendSettings", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "triggerSettings", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "statistics", + "schema": "object", + "required": false, + "description": "" + }, + { + "name": "createdOn", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/autoresponders/statistics", + "method": "getAllStatistics", + "httpMethod": "get", + "tag": "Autoresponders", + "typeScriptTag": "autoresponders", + "description": "The statistics for all autoresponders", + "parameters": [ + { + "name": "query[groupBy]", + "schema": "string", + "required": false, + "description": "Group results by time interval" + }, + { + "name": "query[autoreponderId]", + "schema": "string", + "required": false, + "description": "The list of autoresponder resource IDs (string separated with '')" + }, + { + "name": "query[campaignId]", + "schema": "string", + "required": false, + "description": "The list of campaign resource IDs (string separated with '')" + }, + { + "name": "query[createdOn][from]", + "schema": "undefined", + "required": false, + "description": "Count data from this date" + }, + { + "name": "query[createdOn][to]", + "schema": "undefined", + "required": false, + "description": "Count data to this date" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + }, + { + "url": "/websites", + "method": "getList", + "httpMethod": "get", + "tag": "Websites", + "typeScriptTag": "websites", + "description": "Get the list of websites", + "parameters": [ + { + "name": "query[name]", + "schema": "string", + "required": false, + "description": "Search websites by name" + }, + { + "name": "query[status]", + "schema": "string", + "required": false, + "description": "Search websites by status" + }, + { + "name": "stats[from]", + "schema": "string", + "required": false, + "description": "Show statistics for websites from this date" + }, + { + "name": "stats[to]", + "schema": "string", + "required": false, + "description": "Show statistics for websites to this date" + }, + { + "name": "sort[name]", + "schema": "string", + "required": false, + "description": "Sort websites by name" + }, + { + "name": "sort[createdAt]", + "schema": "string", + "required": false, + "description": "Sort websites by creation date" + }, + { + "name": "sort[updatedAt]", + "schema": "string", + "required": false, + "description": "Sort websites by modification date" + }, + { + "name": "sort[pageViews]", + "schema": "string", + "required": false, + "description": "Sort websites by page views" + }, + { + "name": "sort[visits]", + "schema": "string", + "required": false, + "description": "Sort by number of site visits" + }, + { + "name": "sort[uniqueVisitors]", + "schema": "string", + "required": false, + "description": "Sort by number of unique visitors" + }, + { + "name": "fields", + "schema": "string", + "required": false, + "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma" + }, + { + "name": "perPage", + "schema": "integer", + "required": false, + "description": "Requested number of results per page", + "default": 100 + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "Page number", + "default": 1 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "429", + "description": "" + } + ] + } + ], + "repositoryDescription": "GetResponse is a user-friendly email marketing platform with powerful tools for audience growth, engagement, and conversion. Offering automation, list growth, webinars, and more to help businesses build their brand, sell products, and connect with subscribers efficiently. GetResponse's {language} SDK generated by Konfig (https://konfigthis.com/).", + "logo": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/getresponse/logo.png", + "openApiRaw": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/getresponse/openapi.yaml", + "openApiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/getresponse/openapi.yaml", + "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/getresponse/imagePreview.jpg", + "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/getresponse/favicon.jpg", + "clientNameCamelCase": "getResponse", + "lastUpdated": "2024-03-28T22:38:39.499Z", + "typescriptSdkUsageCode": "import { GetResponse } from 'get-response-typescript-sdk';\n\nconst getResponse = new GetResponse({\n // Header value must be prefixed with api-key\n apiKey: \"X_AUTH_TOKEN\",\n clientId: \"CLIENT_ID\",\n redirectUri: \"REDIRECT_URI\"\n})", + "typescriptSdkFirstRequestCode": "// Get a webinar by ID\nconst getByIdResponse = getResponse.webinars.getById()", + "fixedSpecFileName": "get-response-fixed-spec.yaml" +} \ No newline at end of file diff --git a/sdks/db/published/from-custom-request_peachpayments.com.json b/sdks/db/published/from-custom-request_peachpayments.com.json index 7504703be8..316df6a5d5 100644 --- a/sdks/db/published/from-custom-request_peachpayments.com.json +++ b/sdks/db/published/from-custom-request_peachpayments.com.json @@ -2113,8 +2113,8 @@ "previewLinkImage": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/peach-payments/imagePreview.png", "faviconUrl": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/peach-payments/favicon.png", "clientNameCamelCase": "peachPayments", - "lastUpdated": "2024-03-28T21:38:28.766Z", + "lastUpdated": "2024-03-28T21:39:50.212Z", "typescriptSdkUsageCode": "import { PeachPayments } from 'peach-payments-typescript-sdk';\n\nconst peachPayments = new PeachPayments({\n // Merchant-level authentication (https://developer.peachpayments.com/docs/checkout-js-authentication).\n bearerAuth: \"BEARER_AUTH\"\n})", "typescriptSdkFirstRequestCode": "// Initiate redirect-based Checkout\nconst initiateRedirectCheckoutResponse = peachPayments.checkoutGeneration.initiateRedirectCheckout({\n referer: \"https://mydemostore.com\"\n authentication.entityId: \"8ac7a4ca68c22c4d0168c2caab2e0025\"\n signature: \"a668342244a9c77b08a2f9090d033d6e2610b431a5c0ca975f32035ed06164f4\"\n merchantTransactionId: \"OrderNo453432\"\n amount: 1010.22\n paymentType: \"DB\"\n currency: \"ZAR\"\n nonce: \"UNQ00012345678\"\n shopperResultUrl: \"https://mydemostore.com/OrderNo453432\"\n defaultPaymentMethod: \"CARD\"\n forceDefaultMethod: \"false\"\n merchantInvoiceId: \"INV-0001\"\n cancelUrl: \"https://mydemostore.com/OrderNo453432/cancelled\"\n notificationUrl: \"https://mydemostore.com/OrderNo453432/webhook\"\n customParameters[name]: \"name: Name1 value: Value1\"\n customer.merchantCustomerId: 971020\n customer.givenName: \"John\"\n customer.surname: \"Smith\"\n customer.mobile: 27123456789\n customer.email: \"johnsmith@mail.com\"\n customer.status: \"EXISTING\"\n customer.birthDate: \"1970-02-17\"\n customer.ip: \"192.168.1.1\"\n customer.phone: 27123456789\n customer.idNumber: 9001010000084\n billing.street1: \"1 Example Road\"\n billing.street2: \"LocalityA\"\n billing.city: \"Cape Town\"\n billing.company: \"CompanyA\"\n billing.country: \"ZA\"\n billing.state: \"Western Cape\"\n billing.postcode: 1234\n shipping.street1: \"1 Example Road\"\n shipping.street2: \"LocalityA\"\n shipping.city: \"Cape Town\"\n shipping.company: \"CompanyA\"\n shipping.postcode: 1234\n shipping.country: \"ZA\"\n shipping.state: \"Western Cape\"\n cart.tax: \"15.00\"\n cart.shippingAmount: \"12.25\"\n cart.discount: \"02.25\"\n createRegistration: \"false\"\n originator: \"Webstore\"\n})", "fixedSpecFileName": "peach-payments-fixed-spec.yaml" -} \ No newline at end of file +} diff --git a/sdks/db/spec-data/from-custom-request_getresponse.com.json b/sdks/db/spec-data/from-custom-request_getresponse.com.json new file mode 100644 index 0000000000..07cf7a49ce --- /dev/null +++ b/sdks/db/spec-data/from-custom-request_getresponse.com.json @@ -0,0 +1,51 @@ +{ + "securitySchemes": { + "api-key": { + "type": "apiKey", + "description": "Header value must be prefixed with api-key", + "name": "X-Auth-Token", + "in": "header" + }, + "oauth2": { + "type": "oauth2", + "flows": { + "implicit": { + "authorizationUrl": "https://app.getresponse.com/oauth2_authorize.html", + "scopes": { + "all": "all data access" + } + }, + "authorizationCode": { + "authorizationUrl": "https://app.getresponse.com/oauth2_authorize.html", + "tokenUrl": "https://api.getresponse.com/v3/token", + "scopes": { + "all": "all data access" + } + }, + "clientCredentials": { + "tokenUrl": "https://api.getresponse.com/v3/token", + "scopes": { + "all": "all data access" + } + } + } + } + }, + "apiBaseUrl": "https://api.getresponse.com/v3", + "apiVersion": "3.2024-03-04T09:53:07+0000", + "apiDescription": "\n\n# Limits and throttling\n\nGetResponse API calls are subject to throttling to ensure a high level of service for all users.\n\n## Time frame\n\nTime frame is a period of time for which we calculate the API call limits. The limits reset in every time frame.\n\nThe time frame duration is **10 minutes**.\n\n## Basic rate limits\n\nEach user is allowed to make **30,000 API calls per time frame** (10 minutes) and **80 API calls per second**.\n\n## Parallel requests limit\n\nIt is possible to send up to **10 simultaneous requests**.\n\n## Headers\n\nEvery API response includes a few additional headers:\n\n* `X-RateLimit-Limit` – the total number of requests available per time frame\n* `X-RateLimit-Remaining` – the number of requests left in the current time frame\n* `X-RateLimit-Reset` – seconds left in the current time frame\n\n## Errors\n\nThe **429 Too Many Requests** HTTP response code indicates that the limit has been reached. The error response includes `currentLimit` and `timeToReset` fields in the context section, with the total number of requests available per time frame and seconds left in the current time frame respectively.\n\n## Reaching the limit\n\nWhen you reach the limit, you need to wait for the time specified in `timeToReset` field or `X-RateLimit-Reset` header before making another request.\n\n# Authentication\n\nAPI can be accessed by authenticated users only. This means that every request must be signed with your credentials. We offer two methods of authentication: API Key and OAuth 2.0. API key is our primary method and should be used in most cases. GetResponse MAX clients have to send an `X-Domain` header in addition to the API key. Supported OAuth 2.0 flows are: Authorization Code, Client Credentials, Implicit, and Refresh Token.\n\n## API key\n\nFollow these steps to send an authentication request:\n\n* Find your unique and secret API key in the panel: [https://app.getresponse.com/api](https://app.getresponse.com/api)\n* Add a custom `X-Auth-Token` header to all your requests. For example, if your API key is `jfgs8jh4ksg93ban9Dfgh8`, the header will look like this:\n\n```\nX-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8\n```\n\n**For security reasons, unused API keys expire after 90 days. When that happens, you’ll need to generate a new key to use our API.**\n\n### Example authenticated request\n\n```\n$ curl -H \"X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8\" https://api.getresponse.com/v3/accounts\n```\n\n## OAuth 2.0\n\nTo use OAuth 2.0 authentication, you need to get an \"Access Token\". For more information on how to obtain a token, head to our dedicated page: [OAuth 2.0](/#section/Authentication/Using-OAuth-2.0)\n\nTo authenticate a request using an Access Token, set the value of `Authorization` header to \"Bearer\" followed by the Access Token.\n\n### Example\n\nIf the Access Token is `jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8`\n\n```\nAuthorization: Bearer jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8\n```\n\n## GetResponse MAX\n\nGetResponse MAX customers need to take an extra step to authenticate the request. All requests have to be send with an `X-Domain` header that contains the client's domain. For example:\n\n```\nX-Domain: example.com\n```\n\nPlease note that the header must contain only the domain name, without the protocol identifier (`http://` or `https://`).\n\n## Using OAuth 2.0\n\n### Registering your own application\n\nIf you want to use an OAuth flow to authorize your application, first [register your application](https://app.getresponse.com/authorizations)\n\nYou need to provide a name, short description, and redirect URL.\n\n### Choosing grant flow\n\nOnce your application is registered, you can click on it to see your `client_id` and `client_secret`. They're basically a login and password for your application's access, so be sure not to share them with anyone.\n\nNext, decide which authentication flow (grant type) you want to use. Here are your options:\n\n- choose the **Authorization Code** flow if your application is server-based (you have a server with its own domain and server-side code),\n- choose the **Implicit** flow if your application is based mostly on JavaScript or client-side code,\n- choose the **Client Credential** flow if you want to test your application or access your GetResponse account,\n- implement the **Refresh Token** flow to handle token expiration if you use the Authorization Code flow.\n\n### Authorization Code flow\n\nFirst, your application must redirect a resource owner to the following URL:\n\n```\nhttps://app.getresponse.com/oauth2_authorize.html?response_type=code&client_id=_your_client_id_&state=xyz\n```\n\nThe `state` parameter is there for security reasons and should be a random string. When the resource owner grants your application access to the resource, we will redirect the browser to the `redirect URL` you specified in the application settings and attach the same state as the parameter. Comparing the state parameter value ensures that the redirect was initiated by our system. The code parameter is an authorization code that you can exchange for an access token within 10 minutes, after which time it expires.\n\n#### Example redirect with authorization code\n\n```\nhttps://myredirecturi.com/cb?code=ed17c498bfe343175cd7684c5b09979f2875b25c&state=xyz\n```\n\n#### Exchanging authorization code for the access token\n\nHere's an example request to exchange authorization code for the access token:\n\n```\n$ curl -u client_id:client_secret https://api.getresponse.com/v3/token \\\n -d 'grant_type=authorization_code&code=ed17c498bfe343175cd7684c5b09979f2875b25c'\n```\n\n*Remember to replace `client_id` and `client_secret` with your OAuth application credentials.*\n\n##### Example response\n\n```json\n{\n \"access_token\": \"03807cb390319329bdf6c777d4dfae9c0d3b3c35\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\",\n \"scope\": null,\n \"refresh_token\": \"170d9f64e781aaa6b3ba036083faba71b2fc4e6c\"\n}\n```\n\n### Client Credentials flow\n\nThis flow is suitable for development, when you need to quickly access API to create some functionality. You can get the access token with a single request:\n\n#### Request\n\n```\n$ curl -u client_id:client_secret https://api.getresponse.com/v3/token \\\n -d 'grant_type=client_credentials'\n```\n\n*Remember to replace `client_id` and `client_secret` with your OAuth application credentials.*\n\n#### Response\n\n```json\n{\n \"access_token\": \"e2222af2851a912470ec33c9b4de1ea3a304b7d7\",\n \"expires_in\": 86400,\n \"token_type\": \"Bearer\",\n \"scope\": null\n}\n```\n\nYou can also go to https://app.getresponse.com/manage_api.html, click the action button for your application, and select \"generate credentials\". This will open a popup with a generated access token. You can then use the access token to authenticate your requests, for example:\n\n```\n$ curl -H \"Authorization: Bearer e2222af2851a912470ec33c9b4de1ea3a304b7d7\" https://api.getresponse.com/v3/from-fields\n```\n\n### Implicit flow\n\nFirst, your application must redirect a resource owner to the following URL:\n\n```\nhttps://app.getresponse.com/oauth2_authorize.html?response_type=token&client_id=_your_client_id_&redirect_uri=https://myredirecturi.com/cb&state=xyz\n```\n\nWhen the resource owner grants your application access to the resource, we will redirect the owner to the URL that was specified in the request.\n\nThere is no code exchange process because, unlike the Authorization Code flow, the redirect already has the access token in the parameters.\n\n```\nhttps://myredirecturi.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA&state=xyz&token_type=bearer&expires_in=3600\n```\n\n### Refresh Token flow\n\nYou need to refresh your access token if you receive this error message as a response to your request:\n\n```json\n{\n \"httpStatus\": 401,\n \"code\": 1014,\n \"codeDescription\": \"Problem during authentication process, check headers!\",\n \"message\": \"The access token provided is expired\",\n \"moreInfo\": \"https://apidocs.getresponse.com/v3/errors/1014\",\n \"context\": {\n \"sentToken\": \"b8b1e961a7f9fd4cc710d5d955e09c15a364ab71\"\n }\n}\n```\n\nIf you are using the Authorization Code flow, you need to use the refresh token to issue a new access token/refresh token pair by making the following request:\n\n```\n$ curl -u client_id:client_secret https://api.getresponse.com/v3/token \\\n -d 'grant_type=refresh_token&refresh_token=170d9f64e781aaa6b3ba036083faba71b2fc4e6c'\n```\n\n*Remember to replace `client_id` and `client_secret` with your OAuth application credentials.*\n\nThe response you'll get will look like this:\n\n```json\n{\n \"access_token\": \"890fdsa2f5d7b189fc4e6c4b1d170d9f591238ss\",\n \"expires_in\": 86400,\n \"token_type\": \"Bearer\",\n \"scope\": null,\n \"refresh_token\": \"170d9f64e781aaa6b3ba036083faba71b2fc4e6c\"\n}\n```\n\n### GetResponse MAX\n\nThere are some differences when authenticating GetResponse MAX users:\n\n- the application must redirect to a page in the client's custom domain, for example: `https://custom-domain.getresponse360.com/oauth2_authorize.html`\n- token requests have to be send to one of the GetResponse MAX APIv3 endpoints (depending on the client's environment),\n- token requests have to include an `X-Domain` header,\n- the application has to be registered in a GetResponse MAX account within the same environment.\n\n\n# CORS (AJAX requests)\n\n[Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) mechanism is not supported by APIv3. It means that AJAX requests to the API will be blocked by the browser's [same-origin policy](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy). Please use a server-side application to access the API.\n\n\n# Timezone settings\n\nThe default timezone in response data is **UTC**.\n\nTo set a different timezone, add `X-Time-Zone` header with value of [time zone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) (\"TZ database name\" column).\n\n\n# Pagination\n\nMost of the resource collections returned by API are paginated. It means that the response is divided into multiple pages.\n\nControl the number of results on each page by using `perPage` query parameter and change pages by using `page` query parameter.\n\nBy default we return only the first **100** resources per page. You can change that by adding `perPage` parameter with a value of up to **1000**.\n\nPage numbers start with **1**.\n\nPaginated responses have 3 extra headers:\n* `TotalCount` – a total number of resources on all pages\n* `TotalPages` – a total number of pages\n* `CurrentPage` – current page number\n\nUse the maximum `perPage` value (**1000**) if you plan to iterate over all the pages of the response.\n\nWhen trying to get a page that exceeds the total number of pages, API will return an empty array (`[]`). Make sure to stop iterating when it happens.\n\n\n# CURLE_SSL_CACERT error\n\nSolution to CURLE_SSL_CACERT error (code 60).\n\nThis error is related to expired CA (Certificate Authority) certificates installed on your server (the server that you send the requests from). You can read more about certificate verification on the [cURL project website](https://curl.haxx.se/docs/sslcerts.html).\n\nIf you encounter this error while sending requests to the GetResponse APIv3, ask your server administrator to update the CA certificates using the [latest bundle provided by the cURL project](https://curl.haxx.se/docs/caextract.html).\n\n**Please make sure that cURL is configured to use the updated bundle.**\n", + "apiTitle": "GetResponse APIv3", + "endpoints": 134, + "sdkMethods": 280, + "schemas": 368, + "parameters": 649, + "contactUrl": "https://app.getresponse.com/feedback.html?devzone=yes", + "contactEmail": "getresponse-devzone@cs.getresponse.com", + "originalCustomRequest": { + "type": "GET", + "url": "https://apireference.getresponse.com/open-api.json" + }, + "customRequestSpecFilename": "getresponse.com.yaml", + "difficultyScore": 626.25, + "difficulty": "Very Hard" +} \ No newline at end of file diff --git a/sdks/db/spec-data/sportsdata.io_nfl-v3-projections_1.0.json b/sdks/db/spec-data/sportsdata.io_nfl-v3-projections_1.0.json index 49a72fa958..620fc18d85 100644 --- a/sdks/db/spec-data/sportsdata.io_nfl-v3-projections_1.0.json +++ b/sdks/db/spec-data/sportsdata.io_nfl-v3-projections_1.0.json @@ -28,5 +28,5 @@ "schemas": 13, "parameters": 44, "difficultyScore": 33.5, - "difficulty": "Easy" + "difficulty": "Very Easy" } \ No newline at end of file diff --git a/sdks/db/spec-data/zeno.fm_0.6-99cfdac.json b/sdks/db/spec-data/zeno.fm_0.6-99cfdac.json index bb996cd557..fe1089de85 100644 --- a/sdks/db/spec-data/zeno.fm_0.6-99cfdac.json +++ b/sdks/db/spec-data/zeno.fm_0.6-99cfdac.json @@ -22,5 +22,5 @@ "schemas": 15, "parameters": 32, "difficultyScore": 33.5, - "difficulty": "Easy" + "difficulty": "Very Easy" } \ No newline at end of file diff --git a/sdks/publish.yaml b/sdks/publish.yaml index 01c0816830..4cd7a4d73d 100644 --- a/sdks/publish.yaml +++ b/sdks/publish.yaml @@ -6715,11 +6715,11 @@ publish: Hello there! 👋🏼 We're Ducky, climate enthusiasts passionate about steering the world towards data-driven climate action. We empower YOU to seamlessly track, reduce, and report your climate emissions with our - intuitive software solutions. + intuitive software solutions. 💪🏼 So far, we've assisted over 300 organisations and 90,000 individuals - worldwide in becoming more sustainable – and we'd love to help you, too! + worldwide in becoming more sustainable – and we'd love to help you, too! Would any of our solutions be suitable for you?👇🏽 @@ -6814,11 +6814,11 @@ publish: Además: - · Sin costes de mantenimiento. + · Sin costes de mantenimiento. - · Sin papeles. + · Sin papeles. - · Con comunicación con tu gestoría. + · Con comunicación con tu gestoría. · Con posibilidad de integración con sistemas de nóminas. @@ -6842,11 +6842,11 @@ publish: metaDescription: >- Wannme es una plataforma de pagos que gestiona todo el proceso del cobro, desde la pasarela de pago hasta las comunicaciones de tu tienda física u - online. ¿Cómo lo hacemos? Mediante una única solución, una sola API. + online. ¿Cómo lo hacemos? Mediante una única solución, una sola API. ¿Qué te ofrecemos? Una solución personalizada para ti y tu negocio, con múltiples funcionalidades que puedes combinar libremente, fácil de - integrar, usar y sin sobrecostes. Todo y más a golpe de clic. + integrar, usar y sin sobrecostes. Todo y más a golpe de clic. Queremos ser tu partner tecnológico y acompañarte en todo el proceso de cobro a tus clientes. Con la misma tecnología y procesos que usan los @@ -6889,3 +6889,44 @@ publish: serviceName: false sdkName: onna-{language}-sdk clientName: Onna + from-custom-request_getresponse.com: + homepage: getresponse.com + company: GetResponse + developerDocumentation: apireference.getresponse.com/ + apiStatusUrls: inherit + metaDescription: >- + GetResponse is a comprehensive email marketing platform that provides + small businesses, solopreneurs, coaches, and marketers with powerful and + affordable tools to grow their audience, engage with their subscribers, + and turn subscribers into paying customers. With over 25 years of + expertise, our customers choose GetResponse for our user-friendly + solution, award-winning 24/7 customer support, and powerful tools that go + beyond email marketing – with automation, list growth, and additional + communication tools like webinars and live chats to help businesses build + their personal brand, sell their products and services, and build a + community. + + + GetResponse's powerful email marketing software includes AI-enhanced + content creation tools, professional templates, easy-to-use design tools, + and proven deliverability. Our customers are empowered with tools to build + a website and unlimited landing pages, and create engaging pop-ups and + signup forms. The marketing automation builder brings your ideal automated + communication scenario to life with a visual builder that can grow with + your needs. + + + With our easy-to-use platform, proven expertise, and focus on + user-friendly solutions, GetResponse is the ideal tool for small + businesses, solopreneurs, coaches, and marketers looking to grow their + audience, sell their products and services, and engage with their + subscribers in a meaningful way. + categories: + - email + - marketing + - email_marketing + - marketing_automation + - webinar_funnels + serviceName: false + sdkName: get-response-{language}-sdk + clientName: GetResponse diff --git a/sdks/src/collect-from-custom-requests.ts b/sdks/src/collect-from-custom-requests.ts index e2598cc8ed..4dc9947445 100644 --- a/sdks/src/collect-from-custom-requests.ts +++ b/sdks/src/collect-from-custom-requests.ts @@ -267,6 +267,10 @@ const customRequests: Record = { }); }, }, + "getresponse.com": { + type: "GET", + url: "https://apireference.getresponse.com/open-api.json", + }, "customer.io_DatePipelines": { lambda: async ({ browser }) => { return downloadOpenApiSpecFromRedoclyEmbedded({ @@ -2185,7 +2189,7 @@ const customRequests: Record = { }, "bulksms.com": { type: "GET", - url: "https://www.bulksms.com/developer/json/v1/swagger.yaml?v=9" + url: "https://www.bulksms.com/developer/json/v1/swagger.yaml?v=9", }, "pappers.fr": { type: "GET", @@ -2198,7 +2202,7 @@ const customRequests: Record = { "redkik.com": { type: "GET", url: "https://sales.app.redkik.com/api/v2/apidoc/doc/userservice.json", - apiBaseUrl: "https://sales.app.redkik.com/api/v2/" + apiBaseUrl: "https://sales.app.redkik.com/api/v2/", }, "tramitapp.com": { type: "GET",