Some test http://example.com
","plain":"test 12 Some test"}],"flags":[["clicktrack"]],"fromField":[{"fromFieldId":"V","href":"https://api.getresponse.com/v3/from-fields/V"}],"name":["New message"],"replyTo":[{"fromFieldId":"V","href":"https://api.getresponse.com/v3/from-fields/V"}],"sendSettings":[{"excludedCampaigns":["O"],"excludedSegments":["R"],"externalLexpad":{"dataSourceToken":"cf4dfca78434bf927a7655c0c4d95a2a45c33b71","dataSourceUrl":"https://example.com/external_lexpad"},"perfectTiming":"false","selectedCampaigns":["V"],"selectedContacts":["Qs"],"selectedSegments":["S"],"selectedSuppressions":["Se"],"sendOn":{"date":"2024-07-14T07:00:00","timeZone":{"timeZoneId":282}},"timeTravel":"true"}],"subject":["Annual report"],"trackOpens":["true"]}}}}}},"/newsletters/send-draft":{"post":{"tags":["Newsletters"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#sendDraft","api_endpoint":"https://api.getresponse.com/v3/newsletters/send-draft"},"summary":"Send the newsletter draft","description":"Send the newsletter draft | Send the newsletter draft | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"messageId":{"type":"string","description":"The message identifier (equals to newsletterId)","required":true},"sendSettings":{"type":"object","description":"How the message will be delivered to the subscriber","required":true,"properties":{"excludedCampaigns":{"type":"array","description":"The list of excluded campaigns"},"excludedSegments":{"type":"array","description":"The list of excluded segments"},"externalLexpad":{"type":"object","description":"External Lexpad settings for the message, read more: [External Lexpad](https://apidocs.getresponse.com/v3/dynamic-content/external-lexpad)"},"perfectTiming":{"type":"string","description":"Use the perfect timing functionality"},"selectedCampaigns":{"type":"array","description":"The list of selected campaigns"},"selectedContacts":{"type":"array","description":"The list of selected contacts"},"selectedSegments":{"type":"array","description":"The list of selected segments"},"selectedSuppressions":{"type":"array","description":"The list of selected suppressions (suppressions exclude contacts)"},"sendOn":{"type":"object","description":"The scheduled send date and time for the newsletter. **Please note:** To send your message immediately, omit the `sendOn` section"},"timeTravel":{"type":"string","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":{"messageId":["N"],"sendSettings":[{"excludedCampaigns":["O"],"excludedSegments":["R"],"externalLexpad":{"dataSourceToken":"cf4dfca78434bf927a7655c0c4d95a2a45c33b71","dataSourceUrl":"https://example.com/external_lexpad"},"perfectTiming":"false","selectedCampaigns":["V"],"selectedContacts":["Qs"],"selectedSegments":["S"],"selectedSuppressions":["Se"],"sendOn":{"date":"2024-07-14T07:00:00","timeZone":{"timeZoneId":282}},"timeTravel":"true"}]}}}}}},"/newsletters/statistics":{"get":{"tags":["Newsletters"],"parameters":[{"name":"query[campaignId]","in":"query","description":"The list of campaign resource IDs (string separated with '')","required":false,"schema":{"type":"string","example":""}},{"name":"query[createdOn][from]","in":"query","description":"Count data from this date","required":false,"schema":{"type":"string","example":""}},{"name":"query[createdOn][to]","in":"query","description":"Count data to this date","required":false,"schema":{"type":"string","example":""}},{"name":"query[groupBy]","in":"query","description":"Group results by time interval","required":false,"schema":{"type":"string","example":"","items":{"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","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getNewsletterStatisticsCollection","api_endpoint":"https://api.getresponse.com/v3/newsletters/statistics"},"summary":"Total newsletter statistics","description":"Total newsletter statistics | >This makes it possible to fetch newsletter statistics based on the list of campaign or newsletter IDs\n(you can pass them in the query parameter - see the description below). Remember that all the statistics date ranges\nare 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. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/tags":{"get":{"tags":["Tags"],"parameters":[{"name":"query[createdAt][from]","in":"query","description":"Search tags created from this date","required":false,"schema":{"type":"string","example":""}},{"name":"query[createdAt][to]","in":"query","description":"Search tags created to this date","required":false,"schema":{"type":"string","example":""}},{"name":"query[name]","in":"query","description":"Search tags by name","required":false,"schema":{"type":"string","example":""}},{"name":"sort[createdAt]","in":"query","description":"Sort tags by creation date","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[name]","in":"query","description":"Sort by name","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getTagsList","api_endpoint":"https://api.getresponse.com/v3/tags"},"summary":"Get the list of tags","description":"Get the list of tags | Provides a list of tags. 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. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#createTag","api_endpoint":"https://api.getresponse.com/v3/tags"},"summary":"Add a new tag","description":"Add a new tag | Add a new tag | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"color":{"type":"string","description":"The tag color (deprecated)"},"name":{"type":"string","description":"The tag name","required":true}}},"example":{"color":["string"],"name":["My_Tag"]}}}}}},"/addresses":{"get":{"tags":["Addresses"],"parameters":[{"name":"query[address1]","in":"query","description":"Search addresses by address1 field","required":false,"schema":{"type":"string","example":""}},{"name":"query[address2]","in":"query","description":"Search addresses by address2 field","required":false,"schema":{"type":"string","example":""}},{"name":"query[city]","in":"query","description":"Search addresses by city","required":false,"schema":{"type":"string","example":""}},{"name":"query[company]","in":"query","description":"Search addresses by company","required":false,"schema":{"type":"string","example":""}},{"name":"query[createdOn][from]","in":"query","description":"Search addresses created from this date","required":false,"schema":{"type":"string","example":""}},{"name":"query[createdOn][to]","in":"query","description":"Search addresses created to this date","required":false,"schema":{"type":"string","example":""}},{"name":"query[firstName]","in":"query","description":"Search addresses by first name","required":false,"schema":{"type":"string","example":""}},{"name":"query[lastName]","in":"query","description":"Search addresses by last name","required":false,"schema":{"type":"string","example":""}},{"name":"query[name]","in":"query","description":"Search addresses by name","required":false,"schema":{"type":"string","example":""}},{"name":"query[phone]","in":"query","description":"Search addresses by phone","required":false,"schema":{"type":"string","example":""}},{"name":"query[provinceCode]","in":"query","description":"Search addresses by province code","required":false,"schema":{"type":"string","example":""}},{"name":"query[province]","in":"query","description":"Search addresses by province","required":false,"schema":{"type":"string","example":""}},{"name":"query[zip]","in":"query","description":"Search addresses by ZIP","required":false,"schema":{"type":"string","example":""}},{"name":"sort[createdOn]","in":"query","description":"Sort by date","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getAddressList","api_endpoint":"https://api.getresponse.com/v3/addresses"},"summary":"Get a list of addresses","description":"Get a list of addresses | Sending a **GET** request to this URL returns collection of address resources.\nYou 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:\n* name\n* firstName\n* lastName\n* address1\n* address2\n* city\n* zip\n* province\n* provinceCode\n* phone\n* company\n* createdOn\nThe `name` field can be a pattern and we'll try to match this phrase.\nYou 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).\nLast 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)\n 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. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Addresses"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#createAddress","api_endpoint":"https://api.getresponse.com/v3/addresses"},"summary":"Create address","description":"Create address | Create address | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"address1":{"type":"string","description":"Address line 1"},"address2":{"type":"string","description":"Address line 2"},"addressId":{"type":"string","description":"body.addressId (string field from the documented request schema)"},"city":{"type":"string","description":"body.city (string field from the documented request schema)"},"company":{"type":"string","description":"The company name, free text"},"countryCode":{"type":"string","description":"The country code (ISO 3166-1 alpha-3)","required":true},"countryName":{"type":"string","description":"The country name, based on `countryCode`"},"firstName":{"type":"string","description":"body.firstName (string field from the documented request schema)"},"href":{"type":"string","description":"Direct hyperlink to a resource"},"lastName":{"type":"string","description":"body.lastName (string field from the documented request schema)"},"name":{"type":"string","description":"body.name (string field from the documented request schema)","required":true},"phone":{"type":"string","description":"The phone number, free text"},"province":{"type":"string","description":"body.province (string field from the documented request schema)"},"provinceCode":{"type":"string","description":"The province code, free text"},"zip":{"type":"string","description":"The ZIP/postal code, free text"}}},"example":{"address1":["Arkonska 6"],"address2":[""],"addressId":["k9"],"city":["Gdansk"],"company":["GetResponse"],"countryCode":["POL"],"countryName":["Poland"],"firstName":["John"],"href":["https://api.getresponse.com/v3/addresses/k9"],"lastName":["Doe"],"name":["some_shipping_address"],"phone":["1122334455"],"province":["pomorskie"],"provinceCode":[""],"zip":["80-387"]}}}}}},"/accounts/blocklists":{"get":{"tags":["Accounts"],"parameters":[{"name":"query[mask]","in":"query","description":"Blocklist mask to search for","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getAccountBlocklist","api_endpoint":"https://api.getresponse.com/v3/accounts/blocklists"},"summary":"Returns account blocklist masks","description":"Returns account blocklist masks | Returns account blocklist masks | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Accounts"],"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. \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`.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["add","delete","noResponse"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#updateAccountBlocklist","api_endpoint":"https://api.getresponse.com/v3/accounts/blocklists"},"summary":"Update account blocklist","description":"Update account blocklist | Update account blocklist | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"masks":{"type":"array","description":"body.masks (array field from the documented request schema)","required":true,"items":{"type":"string"}}}},"example":{"masks":[["jack@somedomain.com"]]}}}}}},"/custom-fields":{"get":{"tags":["Custom Fields"],"parameters":[{"name":"query[name]","in":"query","description":"Search custom fields by name","required":false,"schema":{"type":"string","example":""}},{"name":"sort[name]","in":"query","description":"Sort by name","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getCustomFieldList","api_endpoint":"https://api.getresponse.com/v3/custom-fields"},"summary":"Get a list of custom fields","description":"Get a list of custom fields | 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. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Custom Fields"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#createCustomField","api_endpoint":"https://api.getresponse.com/v3/custom-fields"},"summary":"Create a custom field","description":"Create a custom field | Create a custom field | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"The custom field `type` accepts the following values:\n * `string` - input for a string value\n * `number` - input for a numeric value\n * `date` - input for a date\n * `datetime` - input for date and time\n * `country` - input for a country\n * `currency` - input for a currency, allows all ISO 4217 currency codes\n * `phone` - input for a phone number\n * `gender` - input for gender, allows `Male`, `Female` or `Prefer not to say`\n * `ip` - input for an IP address\n * `url` - input for a URL.","required":true},"customFieldId":{"type":"string","description":"Custom field ID"},"fieldType":{"type":"string","description":"Returns the same as `format`"},"format":{"type":"string","description":"The custom field `format` accepts following values:\n * `text` - text input (doesn't require values in the `values` field, you can pass empty array)\n * `textarea` - textarea input (doesn't require values in the `values` field, you can pass empty array)\n * `radio` - radio input (requires at least 2 values in the `values` field)\n * `checkbox` - checkbox input (doesn't require values in the `values` field, you can pass empty array)\n * `single_select` - single select input (requires at least 2 values in the `values` field)\n * `multi_select` - multi select input (requires at least 2 values in the `values` field).","required":true},"hidden":{"type":"string","description":"Whether the custom field is visible to contacts","required":true},"href":{"type":"string","description":"Direct hyperlink to a resource"},"name":{"type":"string","description":"The name of the custom field. It must meet the following requirements:\n * be unique\n * use only lowercase letters, underscores and digits\n * 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`.","required":true},"valueType":{"type":"string","description":"Type of returning value, it returns `type` options extended by a `string` option if the `format` was not defined"},"values":{"type":"array","description":"The list of assigned default values, starting from zero depending on the custom field format. (Please see description).","required":true,"items":{"type":"string"}}}},"example":{"type":["phone"],"customFieldId":["pas"],"fieldType":["text"],"format":["text"],"hidden":["false"],"href":["https://api.getresponse.com/v3/custom-fields/pas"],"name":["office_phone_number"],"valueType":["phone"],"values":[["+48600100200"]]}}}}}},"/lps":{"get":{"tags":["Landing Pages"],"parameters":[{"name":"query[name]","in":"query","description":"Search landing pages by name","required":false,"schema":{"type":"string","example":""}},{"name":"query[status]","in":"query","description":"Search landing pages by status","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["published","unpublished"]}}},{"name":"sort[createdAt]","in":"query","description":"Sort landing pages by creation date","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[leads]","in":"query","description":"Sort landing pages by number of leads","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[name]","in":"query","description":"Sort landing pages by name","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[subscriptionRate]","in":"query","description":"Sort by subscription rate","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[updatedAt]","in":"query","description":"Sort landing pages by modification date","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[visits]","in":"query","description":"Sort by number of page visits","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"stats[from]","in":"query","description":"Show statistics for landing pages from this date","required":false,"schema":{"type":"string","example":""}},{"name":"stats[to]","in":"query","description":"Show statistics for landing pages to this date","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getLpsList","api_endpoint":"https://api.getresponse.com/v3/lps"},"summary":"Get the list of landing pages","description":"Get the list of landing pages | 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. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/multimedia":{"get":{"tags":["Multimedia"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getImageList","api_endpoint":"https://api.getresponse.com/v3/multimedia"},"summary":"Get images list","description":"Get images list | Get images list | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Multimedia"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#uploadImage","api_endpoint":"https://api.getresponse.com/v3/multimedia"},"summary":"Upload image","description":"Upload image | Upload image | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","description":"body.file (string field from the documented request schema)"}}},"example":{"file":["string"]}}}}}},"/tracking":{"get":{"tags":["Tracking"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getTracking","api_endpoint":"https://api.getresponse.com/v3/tracking"},"summary":"Get Tracking JavaScript code snippets","description":"Get Tracking JavaScript code snippets | 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). | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/tracking/facebook-pixels":{"get":{"tags":["Tracking"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getFacebookPixelList","api_endpoint":"https://api.getresponse.com/v3/tracking/facebook-pixels"},"summary":"Get the list of \"Facebook Pixels\"","description":"Get the list of \"Facebook Pixels\" | Returns the name and ID of \"Facebook Pixels\" assigned to a user's account. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/accounts":{"get":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getAccount","api_endpoint":"https://api.getresponse.com/v3/accounts"},"summary":"Account information","description":"Account information | Account information | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#updateAccount","api_endpoint":"https://api.getresponse.com/v3/accounts"},"summary":"Update account","description":"Update account | Update account | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"accountId":{"type":"string","description":"Account ID"},"city":{"type":"string","description":"City"},"companyName":{"type":"string","description":"Company name"},"countryCode":{"type":"object","description":"body.countryCode (object field from the documented request schema)","properties":{"countryCode":{"type":"string","description":"Country code"},"countryCodeId":{"type":"string","description":"Country code ID"}}},"email":{"type":"string","description":"Email"},"firstName":{"type":"string","description":"First name"},"href":{"type":"string","description":"Direct URL to resource"},"industryTag":{"type":"object","description":"body.industryTag (object field from the documented request schema)","properties":{"industryTagId":{"type":"string","description":"Industry tag ID"}}},"lastName":{"type":"string","description":"Last name"},"numberOfEmployees":{"type":"string","description":"Numbers of employees"},"phone":{"type":"string","description":"Phone number"},"state":{"type":"string","description":"State"},"street":{"type":"string","description":"Street"},"timeFormat":{"type":"string","description":"Account time notation"},"timeZone":{"type":"object","description":"body.timeZone (object field from the documented request schema)","properties":{"name":{"type":"string","description":"Time zone name as defined by https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"}}},"zipCode":{"type":"string","description":"ZIP Code"}}},"example":{"accountId":["VfEy1"],"city":["Alderson"],"companyName":["MyBigCompany"],"countryCode":[{"countryCode":"PL","countryCodeId":"175"}],"email":["john.smith@test.com"],"firstName":["John"],"href":["https://api.getresponse.com/v3/accounts"],"industryTag":[{"industryTagId":"1"}],"lastName":["Smith"],"numberOfEmployees":["500"],"phone":["+00155555555"],"state":["Oklahoma"],"street":["Sunset blv."],"timeFormat":["24h"],"timeZone":[{"name":"Europe/Warsaw"}],"zipCode":["81-611"]}}}}}},"/accounts/billing":{"get":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getAccountBilling","api_endpoint":"https://api.getresponse.com/v3/accounts/billing"},"summary":"Billing information","description":"Billing information | Billing information | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/accounts/timezones":{"get":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getTimezones","api_endpoint":"https://api.getresponse.com/v3/accounts/timezones"},"summary":"List of timezones","description":"List of timezones | List of timezones in account's language context. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/accounts/callbacks":{"get":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getCallbacks","api_endpoint":"https://api.getresponse.com/v3/accounts/callbacks"},"summary":"Get callbacks configuration","description":"Get callbacks configuration | Get callbacks configuration | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#updateCallbacks","api_endpoint":"https://api.getresponse.com/v3/accounts/callbacks"},"summary":"Enable or update callbacks configuration","description":"Enable or update callbacks configuration | Enable or update callbacks configuration | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"actions":{"type":"object","description":"body.actions (object field from the documented request schema)","properties":{"click":{"type":"boolean","description":"Is `click` callback enabled","enum":[true,false]},"open":{"type":"boolean","description":"Is `open` callback enabled","enum":[true,false]},"subscribe":{"type":"boolean","description":"Is `subscribe` callback enabled","enum":[true,false]},"survey":{"type":"boolean","description":"Is `survey` callback enabled","enum":[true,false]},"unsubscribe":{"type":"boolean","description":"Is `unsubscribe` callback enabled","enum":[true,false]}}},"url":{"type":"string","description":"URL to use to post notifications, required if callbacks are not yet enabled"}}},"example":{"actions":[{"click":false,"open":false,"subscribe":false,"survey":false,"unsubscribe":false}],"url":["https://example.com/callback"]}}}}},"delete":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#disableCallbacks","api_endpoint":"https://api.getresponse.com/v3/accounts/callbacks"},"summary":"Disable callbacks","description":"Disable callbacks | Disable callbacks | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/accounts/industries":{"get":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getIndustries","api_endpoint":"https://api.getresponse.com/v3/accounts/industries"},"summary":"List of Industry Tags","description":"List of Industry Tags | List of Industry Tags in account's language context. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/accounts/login-history":{"get":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getAccountLoginHistory","api_endpoint":"https://api.getresponse.com/v3/accounts/login-history"},"summary":"History of logins","description":"History of logins | History of logins | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/accounts/badge":{"get":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getAccountBadge","api_endpoint":"https://api.getresponse.com/v3/accounts/badge"},"summary":"Current status of your GetResponse badge","description":"Current status of your GetResponse badge | Current status of your GetResponse badge | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#updateAccountBadge","api_endpoint":"https://api.getresponse.com/v3/accounts/badge"},"summary":"Turn on/off the GetResponse Badge","description":"Turn on/off the GetResponse Badge | Turn on/off the GetResponse Badge | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"Account badge type"},"status":{"type":"string","description":"body.status (string field from the documented request schema)","required":true}}},"example":{"type":["referral"],"status":["enabled"]}}}}}},"/accounts/sending-limits":{"get":{"tags":["Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getSendingLimits","api_endpoint":"https://api.getresponse.com/v3/accounts/sending-limits"},"summary":"Send limits","description":"Send limits | Send limits | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/campaigns":{"get":{"tags":["Campaigns (Lists)"],"parameters":[{"name":"query[isDefault]","in":"query","description":"Retrieve campaigns (contact lists) depending on whether they are marked as default (`isDefault` = `true`)","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"query[name]","in":"query","description":"Retrieve campaigns (contact lists) filtered by name","required":false,"schema":{"type":"string","example":""}},{"name":"sort[createdOn]","in":"query","description":"Sort campaigns (contact lists) by creation date","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[name]","in":"query","description":"Sort by name","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getCampaignList","api_endpoint":"https://api.getresponse.com/v3/campaigns"},"summary":"Get a list of campaigns","description":"Get a list of campaigns | Returns a list of campaigns (contact lists). 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. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Campaigns (Lists)"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#createCampaign","api_endpoint":"https://api.getresponse.com/v3/campaigns"},"summary":"Create a campaign","description":"Create a campaign | This endpoint allows you to create a campaign (contact list). You can create up to 1000 campaigns (contact lists). | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"campaignId":{"type":"string","description":"Unique identifier of the campaign (contact list)"},"createdOn":{"type":"string","description":"The date of creation"},"href":{"type":"string","description":"Direct hyperlink to a resource"},"isDefault":{"type":"string","description":"Is the campaign default"},"languageCode":{"type":"string","description":"The campaign language code according to ISO 639-1, plus: zt - Chinese (Traditional), fs - Afghan Persian (Dari), md - Moldavian"},"name":{"type":"string","description":"The campaign (list) name.\n* You can use each list name just once in your account.\n* The name must be between 3-64 characters.\n* All alphabets supported by GetResponse, including right-to-left ones, are allowed.\n* You can use upper and lower case letters, numbers, spaces and special characters apart from the ones listed below.\n* You can’t use emojis and the following special characters: `/`, `\\`, `@`, and `[` or `]`.","required":true},"techName":{"type":"string","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)"}}},"example":{"campaignId":["V3J"],"createdOn":["2014-02-12T15:19:21+0000"],"href":["https://api.getresponse.com/v3/campaigns/V3J"],"isDefault":["true"],"languageCode":["EN"],"name":["my_campaign"],"techName":["my_campaign"]}}}}}},"/campaigns/statistics/origins":{"get":{"tags":["Campaigns (Lists)"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getCampaignStatisticsOrigins","api_endpoint":"https://api.getresponse.com/v3/campaigns/statistics/origins"},"summary":"Get subscriber origin statistics","description":"Get subscriber origin statistics | The results are indexed with the campaign ID. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/campaigns/statistics/locations":{"get":{"tags":["Campaigns (Lists)"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getCampaignStatisticsLocations","api_endpoint":"https://api.getresponse.com/v3/campaigns/statistics/locations"},"summary":"Get subscriber location statistics","description":"Get subscriber location statistics | The results are indexed with the location name (PL, EN, etc.). | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/campaigns/statistics/list-size":{"get":{"tags":["Campaigns (Lists)"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getCampaignStatisticsListSize","api_endpoint":"https://api.getresponse.com/v3/campaigns/statistics/list-size"},"summary":"Get campaign size statistics","description":"Get campaign size statistics | Returns the number of the total added and removed subscribers, grouped by default or by time period. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/campaigns/statistics/subscriptions":{"get":{"tags":["Campaigns (Lists)"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getCampaignStatisticsSubscriptions","api_endpoint":"https://api.getresponse.com/v3/campaigns/statistics/subscriptions"},"summary":"Get the number and origin of subscription statistics","description":"Get the number and origin of subscription statistics | 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. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/campaigns/statistics/removals":{"get":{"tags":["Campaigns (Lists)"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getCampaignStatisticsRemovals","api_endpoint":"https://api.getresponse.com/v3/campaigns/statistics/removals"},"summary":"Get removal statistics","description":"Get removal statistics | Returns the number and reason for removed contacts. Dates in the YYYY-MM-DD format are used as keys in the response. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/campaigns/statistics/balance":{"get":{"tags":["Campaigns (Lists)"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getCampaignStatisticsBalance","api_endpoint":"https://api.getresponse.com/v3/campaigns/statistics/balance"},"summary":"Get balance statistics","description":"Get balance statistics | Returns the balance of subscriptions. Dates in the YYYY-MM-DD format are used as keys in the response. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/campaigns/statistics/summary":{"get":{"tags":["Campaigns (Lists)"],"parameters":[{"name":"query[campaignId]","in":"query","description":"query[campaignId] (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getCampaignStatisticsSummary","api_endpoint":"https://api.getresponse.com/v3/campaigns/statistics/summary"},"summary":"Get the statistics summary for selected campaigns","description":"Get the statistics summary for selected campaigns | The results are indexed with the campaign ID. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/webforms":{"get":{"tags":["Legacy Forms"],"parameters":[{"name":"query[campaignId]","in":"query","description":"Search Legacy Forms by campaignId. Accepts multiple IDs separated with a comma","required":false,"schema":{"type":"string","example":""}},{"name":"query[modifiedOn][from]","in":"query","description":"Search Legacy Forms modified from this date","required":false,"schema":{"type":"string","example":""}},{"name":"query[modifiedOn][to]","in":"query","description":"Search Legacy Forms modified to this date","required":false,"schema":{"type":"string","example":""}},{"name":"query[name]","in":"query","description":"Search Legacy Forms by name","required":false,"schema":{"type":"string","example":""}},{"name":"sort[modifiedOn]","in":"query","description":"Sort Legacy Forms by modification date","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getLegacyFormList","api_endpoint":"https://api.getresponse.com/v3/webforms"},"summary":"Get Legacy Forms.","description":"Get Legacy Forms. | 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. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/gdpr-fields":{"get":{"tags":["GDPR Fields"],"parameters":[{"name":"sort[createdOn]","in":"query","description":"Sort fields by creation date","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[name]","in":"query","description":"Sort fields by name","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getGDPRFieldList","api_endpoint":"https://api.getresponse.com/v3/gdpr-fields"},"summary":"Get the GDPR fields list","description":"Get the GDPR fields list | Get the GDPR fields list | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/workflow":{"get":{"tags":["Workflows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getWorkflowList","api_endpoint":"https://api.getresponse.com/v3/workflow"},"summary":"Get workflows","description":"Get workflows | Get the list of workflows. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/sms-automation":{"get":{"tags":["SMS Automation Messages"],"parameters":[{"name":"query[campaignId]","in":"query","description":"Search automated SMS messages by campaign (list) ID","required":false,"schema":{"type":"string","example":""}},{"name":"query[hasLinks]","in":"query","description":"Search for automated SMS messages containing links","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"query[name]","in":"query","description":"Search automated SMS messages by name","required":false,"schema":{"type":"string","example":""}},{"name":"sort[clicks]","in":"query","description":"Sort by the number of link clicks","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[delivered]","in":"query","description":"Sort by the number of delivered SMS messages","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[modifiedOn]","in":"query","description":"Sort by the date the SMS message was modified on","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[name]","in":"query","description":"Sort by the name of the automated SMS message","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[sent]","in":"query","description":"Sort by the number of sent SMS messages","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[status]","in":"query","description":"Sort by the status of the SMS message","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getSMSAutomationList","api_endpoint":"https://api.getresponse.com/v3/sms-automation"},"summary":"Get the list of automated SMS messages.","description":"Get the list of automated SMS messages. | 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. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/sms":{"get":{"tags":["SMS Messages"],"parameters":[{"name":"query[campaignId]","in":"query","description":"Search SMS messages by campaign (list) ID","required":false,"schema":{"type":"string","example":""}},{"name":"query[hasLinks]","in":"query","description":"Search for SMS messages with links","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"query[name]","in":"query","description":"Search SMS messages by name","required":false,"schema":{"type":"string","example":""}},{"name":"query[sendingStatus]","in":"query","description":"Search SMS messages by status","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["scheduled","sending","sent"]}}},{"name":"query[type]","in":"query","description":"Search SMS messages by type","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["sms","draft"]}}},{"name":"sort[clicks]","in":"query","description":"Sort by number of link clicks","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[delivered]","in":"query","description":"Sort by number of delivered messages","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[modifiedOn]","in":"query","description":"Sort by modification date","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[name]","in":"query","description":"Sort by name","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[sendOn]","in":"query","description":"Sort by sending date","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[sendingStatus]","in":"query","description":"Sort by sending status","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[sent]","in":"query","description":"Sort by number of sent messages","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getSMSList","api_endpoint":"https://api.getresponse.com/v3/sms"},"summary":"Get the list of SMS messages","description":"Get the list of SMS messages | 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. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]},"post":{"tags":["SMS Messages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#sendSms","api_endpoint":"https://api.getresponse.com/v3/sms"},"summary":"Send an SMS message","description":"Send an SMS message | Sends a new SMS (text) message to a list of recipients | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content":{"type":"string","description":"The SMS message content","required":true},"name":{"type":"string","description":"The SMS message name","required":true},"recipientsType":{"type":"string","description":"The recipient type. To send a text message to contacts in your list, select `contacts`. To message contacts who are not in any of your lists, select `importedNumbers`","required":true}}},"example":{"content":["Sample SMS content"],"name":["New message"],"recipientsType":["contacts"]}}}}}},"/sms/sender-names":{"get":{"tags":["SMS Messages"],"parameters":[{"name":"query[status]","in":"query","description":"Search sender names by status","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getSmsSenderNameList","api_endpoint":"https://api.getresponse.com/v3/sms/sender-names"},"summary":"Get a list of SMS sender names","description":"Get a list of SMS sender names | 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. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/autoresponders":{"get":{"tags":["Autoresponders"],"parameters":[{"name":"query[campaignId]","in":"query","description":"Search autoresponder by campaign ID","required":false,"schema":{"type":"string","example":""}},{"name":"query[createdOn][from]","in":"query","description":"Search autoresponder created from this date","required":false,"schema":{"type":"string","example":""}},{"name":"query[createdOn][to]","in":"query","description":"Search autoresponder created to this date","required":false,"schema":{"type":"string","example":""}},{"name":"query[name]","in":"query","description":"Search autoresponder by name","required":false,"schema":{"type":"string","example":""}},{"name":"query[status]","in":"query","description":"Search autoresponder by status","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["enabled","disabled"]}}},{"name":"query[subject]","in":"query","description":"Search autoresponder by subject","required":false,"schema":{"type":"string","example":""}},{"name":"sort[clickRate]","in":"query","description":"Sort by click rate","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[createdOn]","in":"query","description":"Sort by date","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[dayOfCycle]","in":"query","description":"Sort by cycle day","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[delivered]","in":"query","description":"Sort by delivered","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[name]","in":"query","description":"Sort by name","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[openRate]","in":"query","description":"Sort by open rate","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[subject]","in":"query","description":"Sort by subject","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getAutoresponderList","api_endpoint":"https://api.getresponse.com/v3/autoresponders"},"summary":"Get the list of autoresponders.","description":"Get the list of autoresponders. | 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. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]},"post":{"tags":["Autoresponders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#createAutoresponder","api_endpoint":"https://api.getresponse.com/v3/autoresponders"},"summary":"Create autoresponder","description":"Create autoresponder | >\n**The action-based autoresponder feature has been migrated over to marketing automation. Your existing autoresponders are\nnow converted into workflows. You can no longer create and update action-based autoresponders using our API.**\nThis 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). | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"sendSettings":{"type":"object","description":"How the message will be delivered to the subscriber","required":true,"properties":{"type":{"type":"string","description":"When to send the message","required":true},"excludedDaysOfWeek":{"type":"array","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)"},"externalLexpad":{"type":"object","description":"External Lexpad settings for the message, read more: [External Lexpad](https://apidocs.getresponse.com/v3/dynamic-content/external-lexpad)"},"timeTravel":{"type":"string","description":"Should the message be sent in the user's or the subscriber's time zone"}}}}},"example":{"sendSettings":[{"type":"signup","excludedDaysOfWeek":["Monday"],"externalLexpad":{"dataSourceToken":"cf4dfca78434bf927a7655c0c4d95a2a45c33b71","dataSourceUrl":"https://example.com/external_lexpad"},"timeTravel":"true"}]}}}}}},"/autoresponders/statistics":{"get":{"tags":["Autoresponders"],"parameters":[{"name":"query[autoreponderId]","in":"query","description":"The list of autoresponder resource IDs (string separated with '')","required":false,"schema":{"type":"string","example":""}},{"name":"query[campaignId]","in":"query","description":"The list of campaign resource IDs (string separated with '')","required":false,"schema":{"type":"string","example":""}},{"name":"query[createdOn][from]","in":"query","description":"Count data from this date","required":false,"schema":{"type":"string","example":""}},{"name":"query[createdOn][to]","in":"query","description":"Count data to this date","required":false,"schema":{"type":"string","example":""}},{"name":"query[groupBy]","in":"query","description":"Group results by time interval","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["total","hour","day","month"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getAutoresponderStatisticsCollection","api_endpoint":"https://api.getresponse.com/v3/autoresponders/statistics"},"summary":"The statistics for all autoresponders","description":"The statistics for all autoresponders | >\nThis returns the statistics summary for selected autoresponders. You can select them by specifying the autoresponder or campaign IDs.\nAs in all statistics, you can change the date and time range (hourly daily monthly or total). Keep in mind\nthat 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))\n(https://app.getresponse.com/statistics.html?t=followup#total).\n 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. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}},"/websites":{"get":{"tags":["Websites"],"parameters":[{"name":"query[name]","in":"query","description":"Search websites by name","required":false,"schema":{"type":"string","example":""}},{"name":"query[status]","in":"query","description":"Search websites by status","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["published","unpublished"]}}},{"name":"sort[createdAt]","in":"query","description":"Sort websites by creation date","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[name]","in":"query","description":"Sort websites by name","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[pageViews]","in":"query","description":"Sort websites by page views","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[uniqueVisitors]","in":"query","description":"Sort by number of unique visitors","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[updatedAt]","in":"query","description":"Sort websites by modification date","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"sort[visits]","in":"query","description":"Sort by number of site visits","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ASC","DESC"]}}},{"name":"stats[from]","in":"query","description":"Show statistics for websites from this date","required":false,"schema":{"type":"string","example":""}},{"name":"stats[to]","in":"query","description":"Show statistics for websites to this date","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apireference.getresponse.com#getWebsitesList","api_endpoint":"https://api.getresponse.com/v3/websites"},"summary":"Get the list of websites","description":"Get the list of websites | 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. | Source: official OpenAPI spec at https://apireference.getresponse.com/open-api.json","security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}