Анализ страницы https://emailoctopus.com/api-documentation/v2
Основное Готовность: 85%
Домен
emailoctopus.com
Состояние доменного имени
?
Проверяем корректность доменного имени и наличие технических проблем на уровне домена.
Длина домена велика. Но если вы продвигаете запрос, входящий в название домена, то это хорошо.
Домен второго уровня идеален для продвижения.
Ответ сервера
200 Успешный ответ
HTTP-код ответа и цепочка редиректов
?
Код 200 — страница доступна. Коды 3xx — редиректы (цепочки замедляют загрузку и размывают ссылочный вес). Коды 4xx/5xx — ошибки, поисковик не сможет проиндексировать страницу.
Сервер настроен корректно.
Безопасность
Сайт безопасен
Использование HTTPS и SSL-сертификат
?
HTTPS — обязательный стандарт. Google и Яндекс отдают предпочтение защищённым сайтам. Отсутствие SSL или просроченный сертификат ведут к предупреждениям в браузере и снижению позиций.
На сайте работает защищенный протокол ssl и сайт открывается по https.
Ssl-сертификат действителен до 04.10.2026 22:45:22.
Сервер поддерживает HTTP/3 (QUIC) — новейший протокол.
Включён HSTS (Strict-Transport-Security) — защита от подмены на http.
Поздравляем! Сайт не содержится в реестре РКН.
Кодировка
Кодировка символов страницы
?
Стандарт — UTF-8. Неправильная кодировка вызывает нечитаемые символы и мешает поисковику корректно распознать текст страницы.
Кодировка на странице не определена. Укажите явно кодировку документа!
Язык
Атрибут lang в HTML-теге
?
Атрибут lang (<html lang="ru">) сообщает поисковикам и браузерам, на каком языке написана страница. Помогает при ранжировании в региональном поиске.
Язык страницы не указан. Рекомендуется явно указать язык документа!
Скорость загрузки
~0,32сек
Время отклика сервера (TTFB)
?
Time To First Byte — время до получения первого байта от сервера. Норма до 200 мс. Медленный отклик ухудшает пользовательский опыт и ранжирование: Яндекс и Google учитывают скорость страниц.
Скорость загрузки сайта 0,32сек оптимальна.
Объем документа
129Кб
Размер HTML-кода страницы
?
Слишком большой HTML замедляет парсинг браузером и сканирование поисковым роботом. Рекомендуется не более 200 Кб.
Объем html-документа 129Кб оптимален.
Ресурсы
Ресурсы: 0
Внешние ресурсы страницы (CSS, JS, изображения)
?
Количество и тип подключённых ресурсов влияют на скорость загрузки. Большое число запросов увеличивает время рендеринга страницы.
Ресурсы не найдены. Неужели ваш сайт на чистом html?
Серверные заголовки
Кол-во: 17
HTTP-заголовки ответа сервера
?
Заголовки сервера передают браузеру и поисковику служебную информацию: кеширование, безопасность (CSP, HSTS), сжатие (gzip). Правильная настройка ускоряет загрузку и повышает защищённость.
Найдены серверные заголовки 17шт. Подробнее про серверные заголовки.
Показать полный список серверных заголовков
| Ключ | Значение |
|---|---|
| Date | Sat, 22 Aug 2026 21:48:37 GMT |
| cf-ray | a2f5152f5f699daf-DME |
| cf-cache-status | DYNAMIC |
| Cache-Control | no-cache, private |
| nel | {"report_to":"cf-nel","success_fraction":0.0,"max_age":604800} |
| ETag | W/"fbc0ee4ebad9136e" |
| Server | cloudflare |
| Strict-Transport-Security | max-age=63072000; includeSubDomains; preload |
| Vary | Accept |
| Content-Security-Policy | default-src *;img-src https: blob: data: https://*.stripe.com;font-src 'self' https://fonts.gstatic.com https://gallery.eo.page data:;style-src 'self' https://fonts.googleapis.com https://cdn.zapier.com/packages/partner-sdk/ 'unsafe-inline';script-src 'strict-dynamic' 'nonce-cdkyxFSMzP6/1RiqK5wytLR2vBM=' 'unsafe-eval' https: 'unsafe-inline';base-uri 'none';frame-src 'self' https://dashboard.emailoctopus.com https://emailoctopus.com https://eocampaign.com https://eocampaign1.com https://eomail1.com https://eomail2.com https://eomail3.com https://eomail4.com https://eomail5.com https://eomail6.com https://eomail7.com https://eomail8.com https://eo.page https://www.google.com https://www.youtube-nocookie.com https://*.js.stripe.com https://js.stripe.com https://connect-js.stripe.com https://hooks.stripe.com https://td.doubleclick.net/ https://www.googletagmanager.com/ https://www.facebook.com/ https://docs.google.com/ https://zapier.com/ https://api.zapier.com https://p.datadoghq.eu/;object-src 'none';report-to main-endpoint;worker-src 'self' blob:; |
| permissions-policy | camera=(), display-capture=(), geolocation=(), microphone=() |
| Referrer-Policy | strict-origin-when-cross-origin |
| reporting-endpoints | main-endpoint="https://emailoctopus.com/csp-report" |
| X-Content-Type-Options | nosniff |
| X-Frame-Options | deny |
| report-to | {"group":"cf-nel","max_age":604800,"endpoints":[{"url":"https://a.nel.cloudflare.com/report/v4?s=EjX2qSnfNO0iPhy1S0%2BulsZ2uME%2FSeq%2BrXqJTyn6tzCNkgFhr6oqlJ97ubBONcgzF4%2BvEblN%2BNrsfxGdPgrrsTE0%2FXYpKjGXVHmE2c8c4zRWjOvEvmnLHMKD3IBot%2FhepB0%3D"}]} |
| Alt-Svc | h3=":443" |
CMS
Не определена
Система управления сайтом (движок)
?
CMS — это движок, на котором работает сайт (WordPress, 1C-Bitrix, Tilda и др.). Знание CMS помогает понять возможности SEO-оптимизации и подобрать подходящие инструменты. «Не определена» — вероятно, самописный сайт или нестандартная сборка.
CMS не определена. Вероятно, сайт самописный либо движок надёжно скрыт. Это не ошибка.
Веб-сервер
Программное обеспечение сервера
?
Веб-сервер — это ПО, которое отдаёт страницы посетителям (nginx, Apache, IIS, LiteSpeed и др.). Определяется по серверным заголовкам ответа (Server, X-Powered-By и т.п.). «Не определён» — сервер намеренно скрывает эти заголовки, это нормальная практика безопасности.
Сайт работает на веб-сервере Cloudflare.
Мета-теги Готовность: 7%
Title
Заголовок страницы в браузере и поисковой выдаче
?
Title — главный SEO-заголовок страницы. Влияет на CTR в поиске и ранжирование. Оптимальная длина: 50–70 символов. Ключевые слова — ближе к началу.
Пропишите тег title!
Description
Описание страницы в поисковой выдаче (сниппет)
?
Meta Description — текст под заголовком в выдаче. Напрямую на позиции не влияет, но влияет на CTR. Оптимальная длина: 120–160 символов.
Установите мета-тег description!
Keywords
Список ключевых слов страницы (устаревший тег)
?
Meta Keywords не учитывается Яндексом и Google для ранжирования с 2009–2012 годов. Заполнение не обязательно, но не вредит. Конкурент может использовать содержимое для анализа.
Установите мета-тег keywords!
Канонический Url
Указывает поисковику основную версию страницы
?
Canonical (rel=canonical) предотвращает проблему дублей страниц. Должен точно совпадать с URL проверяемой страницы. Неправильный canonical может передать ссылочный вес на другую страницу.
Рекомендуем прописать канонический Url.
Robots
Ошибок нет
Директивы для поисковых роботов на уровне страницы
?
Meta Robots управляет индексацией конкретной страницы: index/noindex — индексировать ли, follow/nofollow — следовать ли по ссылкам. Noindex полностью исключает страницу из поиска.
Meta-тег robots не указан. Страница свободна для индексации.
Адаптивность
Настройка масштабирования на мобильных устройствах
?
Тег viewport (<meta name="viewport">) сообщает браузеру, как масштабировать страницу на мобильных. Стандарт: width=device-width, initial-scale=1. Отсутствие — признак отсутствия мобильной версии.
Meta-тег viewport не указан. Страница не адаптивная.
Разметка OpenGraph
Не найдено
Мета-теги для красивых превью в соцсетях
?
OpenGraph (og:title, og:description, og:image) управляет тем, как страница выглядит при репосте в социальных сетях и мессенджерах. Отсутствие OG-тегов — невзрачный превью при шеринге.
Разметка OpenGraph не задана. Страница не оптимизирована под социальные сети. Мета-теги с разметкой Og помогают социальным роботам лучше структурировать Ваш сайт.
Все мета-теги
Кол-во: 0
Полный список мета-тегов страницы
?
Таблица всех meta-тегов, включая нестандартные. Позволяет найти опечатки, дубли и лишние теги.
Мета-теги не найдены. Без них роботы и устройства действуют по умолчанию (не всегда это хорошо).
Оптимизация Готовность: 0%
Структура
Есть замечания
Семантические HTML-элементы страницы
?
Проверяет наличие основных структурных элементов: nav, header, footer, main. Корректная семантическая структура помогает поисковику понять архитектуру страницы.
Не найден главный тег документа <body>. Проверьте структуру html-документа на наличие тега <body>!
Строго говоря, это не является ошибкой, а важным замечанием. В стандарте HTML теги html, body не являются обязательными, но все же лучше следовать общепринятым стандартам построения веб-страниц.
Строго говоря, это не является ошибкой, а важным замечанием. В стандарте HTML теги html, body не являются обязательными, но все же лучше следовать общепринятым стандартам построения веб-страниц.
Контент
Есть ошибки
Объём и качество текстового содержимого
?
Анализирует объём полезного текста на странице. Слишком мало — страница может считаться малополезной. Слишком много — ухудшается читаемость и восприятие.
Слова из title 0 встречаются в тексте редко. Добавьте в контент страницы слова из тега <title>!
Абзацев с текстом 0 слишком мало. Добавьте больше абзацев с текстом (тег <p>)!
Среднее число слов в абзаце 0 слишком мало. Сделайте контент более читаемым!
Кол-во знаков контента 131480 на странице оптимально.
Кол-во слов 5168 на странице оптимально.
Заголовки
Есть ошибки
Иерархия заголовков H1–H6
?
H1 должен быть один и содержать ключевой запрос. H2–H6 описывают подразделы. Пропуск уровней (H1 → H3) и несколько H1 — типичные ошибки, снижающие понятность страницы для поисковика.
Не обнаружено заголовков на странице. Добавьте заголовки (<h1>, <h2> или <h3>)
Тошнота
16,25
Насколько одно слово доминирует в тексте
?
Классическая тошнота = √(частота самого повторяющегося слова). Норма до 7–8: текст воспринимается естественно. Выше — поисковик может счесть страницу переспамленной.
Тошнота превышает норму 5. Измените текст страницы!
Академич. тошнота
38,31%
Насколько текст перенасыщен ключевыми словами
?
Академическая тошнота = (частота слова / общее количество слов) × 100%. Показывает долю конкретного слова в тексте. Норма 5–15%.
Академическая тошнота превышает норму 5-15%. Измените текст страницы!
Семантическое ядро
20
Наиболее часто встречающиеся слова на странице
?
Топ слов по частоте использования. Показывает, какие слова доминируют в тексте с точки зрения поисковика.
Контент страницы содержит осмысленный текст и слова.
Показать список слов
| Слово | Кол-во | Частота |
|---|---|---|
| "description":"error | 264 | 5,11% |
| description | 139 | 2,69% |
| "detail":{"type":"string" | 139 | 2,69% |
| occurred | 129 | 2,50% |
| "description":"the | 127 | 2,46% |
| "content":{"application\/json":{"schema":{"type":"object" | 121 | 2,34% |
| "status":{"type":"string" | 120 | 2,32% |
| "title":{"type":"string" | 115 | 2,23% |
| status | 114 | 2,21% |
| "properties":{"type":{"type":"string" | 114 | 2,21% |
| "description":"general | 114 | 2,21% |
| "description":"response | 114 | 2,21% |
| request | 109 | 2,11% |
| "enum":["https:\/\/emailoctopus | 102 | 1,97% |
| "default":"an | 102 | 1,97% |
| "description":"a | 67 | 1,30% |
| "deprecated":false | 49 | 0,95% |
| denied | 46 | 0,89% |
| contact | 43 | 0,83% |
| "items":{"type":"object" | 41 | 0,79% |
Индексация Готовность: 100%
Индексирование
Ошибок нет
Разрешено ли индексирование страницы
?
Проверяет, не закрыта ли страница от индексации через robots.txt, meta robots или X-Robots-Tag. Страница, закрытая от индексации, не появится в поисковой выдаче.
Анкоров на странице 18 оптимально. Поисковые роботы обязательно проиндексируют сайт.
Robots.txt
Найден корректный robots.txt
Файл управления сканированием сайта роботами
?
Robots.txt указывает поисковым роботам, какие страницы сканировать, а какие — нет. Ошибки в файле могут случайно закрыть важные разделы от индексации.
Robots.txt настроен корректно. Размер файла: 80 байт. Загружен за: 1сек.
Проверяемая страница не запрещена в robots.txt.
Robots.txt доступен по постоянному адресу
Показать содержимое robots.txt
User-agent: *
Disallow: /admin/*
Sitemap: https://emailoctopus.com/sitemap.xml
Sitemap
Кол-во: 1
XML-карта сайта для поисковиков
?
Sitemap.xml помогает поисковику быстрее находить и индексировать страницы. Особенно важен для крупных сайтов и новых страниц, на которые ещё нет входящих ссылок.
Robots.txt содержит карту сайта. Это прекрасно!
Robots.txt не содержит ошибок в карте сайта.
Показать карту сайта
| Url | Статус |
|---|---|
| https://emailoctopus.com/sitemap.xml |
|
Внутренние ссылки
Кол-во: 17
Ссылки на другие страницы своего сайта
?
Внутренние ссылки распределяют ссылочный вес между страницами и помогают поисковику обходить сайт. Пустые анкоры и ссылки на запрещённые robots.txt страницы — типичные ошибки.
Внутренних ссылок на странице 17 оптимально.
Внутренние ссылки не запрещены к индексации в robots.txt.
Показать внутренние ссылки
| Url | Анкор | Состояние |
|---|---|---|
| /\"https:\/\/emailoctopus.com\/account\/sign-up\" |
create an account<\/a> before using the API, if you don't already have one.\n\nThe API is designed around
|
|
| /\"https:\/\/en.wikipedia.org\/wiki\/REST\" |
REST<\/a> principles. It has a predictable URL structure based on resources, accepts
|
|
| /\"https:\/\/www.json.org\/json-en.html\" |
JSON-encoded<\/a> request bodies, returns JSON-encoded responses and uses standard HTTP response codes, authentication and verbs.\n\nThe base URL for the API is https:\/\/api.emailoctopus.com.\n\n# Authentication\nTo use the API, you'll need to generate an API key. You can do this in your
|
|
| /\"https:\/\/emailoctopus.com\/developer\/api-keys\" |
account settings<\/a>. If you have an API key created prior to the release of API v2 (labelled 'legacy') you'll need to generate a new API key. New API keys are compatible with all versions of the API.\n\nThe API uses bearer authentication to authenticate requests. Authenticate your request by including the following header:\n```\nAuthorization: Bearer {token}\n```\n\nFor example, using curl:\n```\ncurl https:\/\/api.emailoctopus.com\/lists\/ -H \"Authorization: Bearer {token}\"\n```\n\nIf you see a JSON-formatted response with your list details, that's great! That means you can connect to the API, and your authentication token works.\n\nIf you encounter a JSON error response, refer to the `type` field for a link to detailed documentation. For non-JSON errors, the request likely didn't reach the server. In that case, double-check the URL and verify that your request is correctly formatted.\n\n# Rate limiting\nRequests to the API are subject to a rate limit, which is implemented using the
|
|
| /\"https:\/\/en.wikipedia.org\/wiki\/Token_bucket\" |
token bucket algorithm<\/a>. Each request consumes one token and your bucket holds up to 100 tokens. Tokens are replenished at a rate of 10 per second. To check your remaining tokens, refer to the `X-RateLimiting-Remaining` header in the response.\n\nThis system enables a steady request rate of up to 10 per second or a burst of up to 100 requests in a single instance if needed.\n\nIf your account exceeds the rate limit, the request will return a [429 HTTP status code](https:\/\/emailoctopus.com\/api-documentation\/v2#too-many-requests).\n\n# Pagination\nWhen you request a collection of entities, such as contacts belonging to a list, the data will be paginated rather than returned all at once. Each response will contain a maximum of 100 results in the `data` attribute.\n\nPagination information is included in the response `paging` attribute. This data will contain `next` attributes, with a URL and a `starting_after` cursor. The cursor serves as a link to the next page. You can use the cursor as a `starting_after` query string parameter to navigate to the next page or follow the provided URL in the JSON structure.\n\nHere's an example of what the `paging` attribute looks like:\n```\n\"paging\": {\n \"next\": {\n \"url\": \"https:\/\/api.emailoctopus.com\/lists\/{list_id}\/contacts?starting_after=WyIyMDI0LTEyLTA3VDE1OjAzOjAxKzAwOjAwIiwiNDYzN2RmYTAtYjZmMC0xMWVmLWFjZDYtZjU5YjA4MDFlMjBkIl0&limit=100\",\n \"starting_after\": \"WyIyMDI0LTEyLTA3VDE1OjAzOjAxKzAwOjAwIiwiNDYzN2RmYTAtYjZmMC0xMWVmLWFjZDYtZjU5YjA4MDFlMjBkIl0\"\n }\n }\n```\nYou can add the cursor to your request URL by including the `starting_after` query string parameter, like this:\n```\nhttps:\/\/api.emailoctopus.com\/lists\/{list_id}\/contacts?starting_after=WyIyMDI0LTEyLTA3VDE1OjAzOjAxKzAwOjAwIiwiNDYzN2RmYTAtYjZmMC0xMWVmLWFjZDYtZjU5YjA4MDFlMjBkIl0\n```\n\nThe cursor should always be provided exactly as it was returned in a previous request. Avoid deconstructing the cursor and relying on any data inside it, as the implementation of the cursor is subject to change.\n\n# Errors\nError are returned in a standardised format following
|
|
| /\"https:\/\/datatracker.ietf.org\/doc\/html\/rfc7807\" |
RFC 7807<\/a>. For example:\n\n```\n{\n \"title\": \"An error occurred.\",\n \"detail\": \"Bad request.\",\n \"status\": 400,\n \"type\": \"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request\"\n}\n```\n\nYou can use the `type` value to navigate to the documentation for more details about the specific error.\n\nYou may also encounter validation errors, which will return a 422 HTTP status code and a payload formatted according to
|
|
| /\"https:\/\/www.rfc-editor.org\/rfc\/rfc9457.html\" |
RFC 9457<\/a>.\n```\n{\n \"title\": \"An error occurred.\",\n \"detail\": \"Unprocessable content.\",\n \"status\": 422,\n \"errors\": [\n {\n \"detail\": \"This value should not be blank.\",\n \"pointer\": \"\/email_address\"\n }\n ],\n \"type\": \"https:\/\/emailoctopus.com\/api-documentation\/v2#unprocessable-content\"\n}\n```\n\nIn the following sections, you can find more information about each type of error.\n\n## access-denied\nYou do not have permission to access the requested entity, such as trying to get the contacts in a list belonging to another account.\n\nCheck that the API key you're using belongs to the account you're trying to access data in. You can verify this by navigating to the account's
|
|
| /\"https:\/\/emailoctopus.com\/developer\/api-keys\" |
API keys<\/a> and checking there's a key ending in the same four characters.\n\n## already-exists\nYou are attempting to create an entity that already exists, such as creating a tag on a list that already contains that tag, or adding a contact to a list that already includes that contact.\n\nYou can fix this by checking if the entity already exists before you attempt to create it. Or you may wish to handle the error gracefully in your code and update the existing resource when a duplicate is spotted.\n\nSome endpoints, such as the [create or update contact](#tag\/Contact\/operation\/api_lists_list_idcontacts_put) endpoint, support an *upsert* operation. An upsert allows you to either update the entity if it exists or create a new one if it doesn't. Consider using this feature where applicable.\n\n## bad-request\nThe request body is not in the format expected. Check that the request body is valid JSON.\n\n## conflict\nThis request conflicts with the system state.
|
|
| /\"https:\/\/help.emailoctopus.com\/category\/20-getting-in-touch\" |
Get in touch<\/a> if you require further assistance.\n\n## internal-error\nThis error is returned when the API encounters an unexpected condition or an internal issue on the server. If you receive this error, it is probably not an issue with your request.\n\nIn some cases, retrying the request after some time may resolve the issue. We'll always be notified of the error via our internal tracking tools, but if the problem persists,
|
|
| /\"https:\/\/help.emailoctopus.com\/category\/20-getting-in-touch\" |
get in touch<\/a> with details about the error and we'll investigate.\n\n## not-found\nThe resource you're trying to access or modify could not be found. This error is typically caused by using an invalid or incorrect identifier, such as a list ID or contact ID that doesn't exist in your account.\n\nDouble-check the resource identifiers you're using in your request, and ensure they match the actual resources in your EmailOctopus account.\n\n## out-of-limits\nExecuting this operation would cause you to exceed your plan limits. See our
|
|
| /\"https:\/\/datatracker.ietf.org\/doc\/html\/rfc7807\" |
[RFC 7807]<\/a> to the value in the request document that caused the error."}},"example":{"detail":"This value is not a valid email address.","pointer":"\/email_address"}}}}}}}}},"summary":"Create or update contact","description":"This is an *upsert* endpoint. If the contact does not exist, it will be created. If the contact already exists, it will be updated.","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"}],"requestBody":{"description":"","content":{"application\/json":{"schema":{"type":"object","description":"","deprecated":false,"required":["email_address"],"properties":{"email_address":{"type":"string","description":"The email address of the contact.","example":"otto@example.com"},"fields":{"type":"object","description":"An object containing key\/value pairs of field values, using the field's tag as the key.","additionalProperties":{"description":"The value of the field.","x-additionalPropertiesName":"field tag","anyOf":[{"type":"string","title":"Text","description":"The value for a \"text\" field."},{"type":"integer","title":"Number","description":"The value for a \"number\" field."},{"type":"string","title":"Date","description":"The value for a \"date\" field."},{"type":"string","title":"Single Choice","description":"The value for a \"choice_single\" field."},{"type":"Array of strings","title":"Multiple Choice","description":"The value for a \"choice_multiple\" field."},{"type":"null","title":"Unset","description":"Remove the field from the contact."}]},"example":{"referral":"Otto","birthday":"2015-12-01","how_many_pets":2,"fieldToRemove":null}},"tags":{"type":"object","description":"An object containing key\/value pairs, where the key is the tag name and the value is true to add the tag or false to remove it. Tags that are not referenced in the object will not be updated.","additionalProperties":{"type":"boolean"},"example":{"vip":true,"tagToRemove":false}},"status":{"type":"string","description":"The status of the contact.","example":"subscribed","enum":["pending","subscribed","unsubscribed"]}}}}},"required":false}},"post":{"operationId":"api_lists_list_idcontacts_post","tags":["Contact"],"responses":{"201":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ListContact-get"}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"],"default":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Bad request."},"status":{"type":"string","description":"Response status.","default":400},"errors":{"type":"array","items":{"type":"object","required":["detail"],"properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the value in the request document that caused the error.","default":"name"},"parameter":{"type":"string","description":"Name of the url parameter containing the error.","default":"list_id"},"detail":{"type":"string","description":"Error description.","default":"This value should be between 1 and 100."}}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"404":{"description":"Resource not found.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#not-found"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource not found."},"status":{"type":"string","description":"Response status.","default":404}}}}}},"409":{"description":"Conflict.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#conflict"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource already exists."},"status":{"type":"string","description":"Response status.","default":409}}}}}},"422":{"description":"Unprocessable content.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#unprocessable-content"},"title":{"type":"string","description":"General error title: `An error occurred.`","example":"An error occurred."},"detail":{"type":"string","description":"Error description: `Unprocessable content.`","example":"Unprocessable content."},"status":{"type":"string","description":"Response status: `422`","example":422},"errors":{"type":"array","description":"Validation errors","items":{"type":"object","properties":{"detail":{"type":"string","description":"Error description."},"pointer":{"type":"string","description":"A JSON Pointer
|
|
| /\"https:\/\/datatracker.ietf.org\/doc\/html\/rfc7807\" |
[RFC 7807]<\/a> to the value in the request document that caused the error."}},"example":{"detail":"This value is not a valid email address.","pointer":"\/email_address"}}}}}}}}},"summary":"Create contact","description":"","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"}],"requestBody":{"description":"","content":{"application\/json":{"schema":{"type":"object","description":"","deprecated":false,"required":["email_address"],"properties":{"email_address":{"type":"string","description":"The email address of the contact.","example":"otto@example.com"},"fields":{"type":"object","description":"An object containing key\/value pairs of field values, using the field's tag as the key.","additionalProperties":{"description":"The value of the field.","x-additionalPropertiesName":"field tag","anyOf":[{"type":"string","title":"Text","description":"The value for a \"text\" field."},{"type":"integer","title":"Number","description":"The value for a \"number\" field."},{"type":"string","title":"Date","description":"The value for a \"date\" field."},{"type":"string","title":"Single Choice","description":"The value for a \"choice_single\" field."},{"type":"Array of strings","title":"Multiple Choice","description":"The value for a \"choice_multiple\" field."},{"type":"null","title":"Unset","description":"Remove the field from the contact."}]},"example":{"referral":"Otto","birthday":"2015-12-01","how_many_pets":2,"fieldToRemove":null}},"tags":{"type":"array","description":"An array of tags associated with the contact.","items":{"type":"string","example":"vip"}},"status":{"type":"string","description":"The status of the contact.","example":"subscribed","enum":["pending","subscribed","unsubscribed"]}}}}},"required":false}}},"\/lists\/{list_id}\/contacts\/batch":{"put":{"operationId":"api_lists_list_idcontactsbatch_put","tags":["Contact"],"responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"object","properties":{"success":{"type":"array","items":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the contact was successfully updated.","example":true},"data":{"$ref":"#\/components\/schemas\/ListContact-get"}}}},"errors":{"type":"array","items":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the contact was successfully updated.","example":false},"id":{"type":"string","description":"The ID of the contact.","example":"00000000-0000-0000-0000-000000000000"},"type":{"type":"string","description":"The type of error.","example":"invalid_field"},"title":{"type":"string","description":"The title of the error.","example":"Invalid field"},"detail":{"type":"string","description":"The detail of the error.","example":"The field \"email_address\" is invalid"},"status":{"type":"integer","description":"The HTTP status code of the error.","example":400},"data":{"type":"null"}}}}}}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"],"default":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Bad request."},"status":{"type":"string","description":"Response status.","default":400},"errors":{"type":"array","items":{"type":"object","required":["detail"],"properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the value in the request document that caused the error.","default":"name"},"parameter":{"type":"string","description":"Name of the url parameter containing the error.","default":"list_id"},"detail":{"type":"string","description":"Error description.","default":"This value should be between 1 and 100."}}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"404":{"description":"Resource not found.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#not-found"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource not found."},"status":{"type":"string","description":"Response status.","default":404}}}}}},"422":{"description":"Unprocessable content.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unprocessable-content"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Unprocessable content."},"status":{"type":"string","description":"Response status.","default":422},"errors":{"type":"array","items":{"type":"object","required":["detail"],"properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the value in the request document that caused the error.","default":"name"},"parameter":{"type":"string","description":"Name of the url parameter containing the error.","default":"list_id"},"detail":{"type":"string","description":"Error description.","default":"This value should be between 1 and 100."}}}}}}}}}},"summary":"Update multiple list contacts","description":"","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"}],"requestBody":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ListContactBatch-put"}}},"required":false}}},"\/lists\/{list_id}\/contacts\/{contact_id}":{"get":{"operationId":"api_lists_list_idcontacts_contact_id_get","tags":["Contact"],"responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ListContact-get"}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title: `An error occurred.`","example":"An error occurred."},"detail":{"type":"string","description":"Error description: `Bad request.`","example":"Bad request."},"status":{"type":"string","description":"Response status: `400`","example":400},"errors":{"type":"array","description":"Validation errors","items":{"type":"object","properties":{"detail":{"type":"string","description":"Error description."},"parameter":{"type":"string","description":"Name of the url parameter containing the error."}},"example":{"detail":"This value is not a valid UUID.","parameter":"list_id"}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"404":{"description":"Resource not found.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#not-found"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource not found."},"status":{"type":"string","description":"Response status.","default":404}}}}}}},"summary":"Get contact","description":"","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"},{"name":"contact_id","in":"path","description":"The ID of the contact, or an MD5 hash of the lowercase version of the contact's email address.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"631251b876fece73bc9dd647fe596d5f"}]},"put":{"operationId":"api_lists_list_idcontacts_contact_id_put","tags":["Contact"],"responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ListContact-get"}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"],"default":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Bad request."},"status":{"type":"string","description":"Response status.","default":400},"errors":{"type":"array","items":{"type":"object","required":["detail"],"properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the value in the request document that caused the error.","default":"name"},"parameter":{"type":"string","description":"Name of the url parameter containing the error.","default":"list_id"},"detail":{"type":"string","description":"Error description.","default":"This value should be between 1 and 100."}}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"404":{"description":"Resource not found.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#not-found"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource not found."},"status":{"type":"string","description":"Response status.","default":404}}}}}},"409":{"description":"Conflict.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#conflict"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource already exists."},"status":{"type":"string","description":"Response status.","default":409}}}}}},"422":{"description":"Unprocessable content.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#unprocessable-content"},"title":{"type":"string","description":"General error title: `An error occurred.`","example":"An error occurred."},"detail":{"type":"string","description":"Error description: `Unprocessable content.`","example":"Unprocessable content."},"status":{"type":"string","description":"Response status: `422`","example":422},"errors":{"type":"array","description":"Validation errors","items":{"type":"object","properties":{"detail":{"type":"string","description":"Error description."},"pointer":{"type":"string","description":"A JSON Pointer
|
|
| /\"https:\/\/datatracker.ietf.org\/doc\/html\/rfc7807\" |
[RFC 7807]<\/a> to the value in the request document that caused the error."}},"example":{"detail":"This value is not a valid email address.","pointer":"\/email_address"}}}}}}}}},"summary":"Update contact","description":"","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"},{"name":"contact_id","in":"path","description":"The ID of the contact, or an MD5 hash of the lowercase version of the contact's email address.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"631251b876fece73bc9dd647fe596d5f"}],"requestBody":{"description":"","content":{"application\/json":{"schema":{"type":"object","description":"","deprecated":false,"properties":{"email_address":{"type":"string","description":"The email address of the contact.","example":"otto@example.com"},"fields":{"type":"object","description":"An object containing key\/value pairs of field values, using the field's tag as the key.","additionalProperties":{"description":"The value of the field.","x-additionalPropertiesName":"field tag","anyOf":[{"type":"string","title":"Text","description":"The value for a \"text\" field."},{"type":"integer","title":"Number","description":"The value for a \"number\" field."},{"type":"string","title":"Date","description":"The value for a \"date\" field."},{"type":"string","title":"Single Choice","description":"The value for a \"choice_single\" field."},{"type":"Array of strings","title":"Multiple Choice","description":"The value for a \"choice_multiple\" field."},{"type":"null","title":"Unset","description":"Remove the field from the contact."}]},"example":{"referral":"Otto","birthday":"2015-12-01","how_many_pets":2,"fieldToRemove":null}},"tags":{"type":"object","description":"An object containing key\/value pairs, where the key is the tag name and the value is true to add the tag or false to remove it. Tags that are not referenced in the object will not be updated.","additionalProperties":{"type":"boolean"},"example":{"vip":true,"tagToRemove":false}},"status":{"type":"string","description":"The status of the contact.","example":"subscribed","enum":["pending","subscribed","unsubscribed"]}}}}},"required":false}},"delete":{"operationId":"api_lists_list_idcontacts_contact_id_delete","tags":["Contact"],"responses":{"204":{"description":"No content."},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"],"default":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Bad request."},"status":{"type":"string","description":"Response status.","default":400},"errors":{"type":"array","items":{"type":"object","required":["detail"],"properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the value in the request document that caused the error.","default":"name"},"parameter":{"type":"string","description":"Name of the url parameter containing the error.","default":"list_id"},"detail":{"type":"string","description":"Error description.","default":"This value should be between 1 and 100."}}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"404":{"description":"Resource not found.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#not-found"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource not found."},"status":{"type":"string","description":"Response status.","default":404}}}}}}},"summary":"Delete contact","description":"","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"},{"name":"contact_id","in":"path","description":"The ID of the contact, or an MD5 hash of the lowercase version of the contact's email address.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"631251b876fece73bc9dd647fe596d5f"}]}},"\/lists\/{list_id}\/fields":{"post":{"operationId":"api_lists_list_idfields_post","tags":["Field"],"responses":{"201":{"description":"Successful response","content":{"application\/json":{"schema":{"oneOf":[{"title":"Text, number or date field","description":"A field that accepts a single value.","type":"object","properties":{"label":{"type":"string","description":"A human readable label for the field.","example":"What is your hometown?"},"tag":{"type":"string","description":"The ID used to reference the field in your emails.","example":"Hometown"},"type":{"type":"string","description":"The type of the field.","example":"text","enum":["text","number","date"]},"fallback":{"type":["string",null],"description":"A default value for the field, used in campaigns when there is no other value available.","example":"Unknown"}},"required":["label","tag","type"]},{"title":"Choice field","description":"A field that accepts a single value from a list of choices.","type":"object","properties":{"label":{"type":"string","description":"A human readable label for the field.","example":"What is your hometown?"},"tag":{"type":"string","description":"The ID used to reference the field in your emails.","example":"Hometown"},"type":{"type":"string","description":"The type of the field.","example":"choice_single","enum":["choice_single","choice_multiple"]},"choices":{"type":"array","description":"An array of choices for the field.","items":{"type":"string"},"example":["One","Two"]},"fallback":{"type":["string",null],"description":"A default value for the field, used in campaigns when there is no other value available.","example":"Unknown"}},"required":["label","tag","type","choices"]}]}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"],"default":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Bad request."},"status":{"type":"string","description":"Response status.","default":400},"errors":{"type":"array","items":{"type":"object","required":["detail"],"properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the value in the request document that caused the error.","default":"name"},"parameter":{"type":"string","description":"Name of the url parameter containing the error.","default":"list_id"},"detail":{"type":"string","description":"Error description.","default":"This value should be between 1 and 100."}}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"404":{"description":"Resource not found.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#not-found"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource not found."},"status":{"type":"string","description":"Response status.","default":404}}}}}},"409":{"description":"Conflict.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#conflict"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource already exists."},"status":{"type":"string","description":"Response status.","default":409}}}}}},"422":{"description":"Unprocessable content.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#unprocessable-content"},"title":{"type":"string","description":"General error title: `An error occurred.`","example":"An error occurred."},"detail":{"type":"string","description":"Error description: `Unprocessable content.`","example":"Unprocessable content."},"status":{"type":"string","description":"Response status: `422`","example":422},"errors":{"type":"array","description":"Validation errors","items":{"type":"object","properties":{"detail":{"type":"string","description":"Error description."},"pointer":{"type":"string","description":"A JSON Pointer
|
|
| /\"https:\/\/datatracker.ietf.org\/doc\/html\/rfc7807\" |
[RFC 7807]<\/a> to the value in the request document that caused the error."}},"example":{"detail":"This value must be string type, int provided.","pointer":"\/tag"}}}}}}}}},"summary":"Create field","description":"","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"}],"requestBody":{"description":"","content":{"application\/json":{"schema":{"oneOf":[{"title":"Text, number or date field","description":"A field that accepts a single value.","type":"object","properties":{"label":{"type":"string","description":"A human readable label for the field.","example":"What is your hometown?"},"tag":{"type":"string","description":"The ID used to reference the field in your emails.","example":"Hometown"},"type":{"type":"string","description":"The type of the field.","example":"text","enum":["text","number","date"]},"fallback":{"type":["string",null],"description":"A default value for the field, used in campaigns when there is no other value available.","example":"Unknown"}},"required":["label","tag","type"]},{"title":"Choice field","description":"A field that accepts a single value from a list of choices.","type":"object","properties":{"label":{"type":"string","description":"A human readable label for the field.","example":"What is your hometown?"},"tag":{"type":"string","description":"The ID used to reference the field in your emails.","example":"Hometown"},"type":{"type":"string","description":"The type of the field.","example":"choice_single","enum":["choice_single","choice_multiple"]},"choices":{"type":"array","description":"An array of choices for the field.","items":{"type":"string"},"example":["One","Two"]},"fallback":{"type":["string",null],"description":"A default value for the field, used in campaigns when there is no other value available.","example":"Unknown"}},"required":["label","tag","type","choices"]}]}}},"required":true}}},"\/lists\/{list_id}\/fields\/{tag}":{"put":{"operationId":"api_lists_list_idfields_tag_put","tags":["Field"],"responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"oneOf":[{"title":"Text, number or date field","description":"A field that accepts a single value.","type":"object","properties":{"label":{"type":"string","description":"A human readable label for the field.","example":"What is your hometown?"},"tag":{"type":"string","description":"The ID used to reference the field in your emails.","example":"Hometown"},"type":{"type":"string","description":"The type of the field.","example":"text","enum":["text","number","date"]},"fallback":{"type":["string",null],"description":"A default value for the field, used in campaigns when there is no other value available.","example":"Unknown"}},"required":["label","tag","type"]},{"title":"Choice field","description":"A field that accepts a single value from a list of choices.","type":"object","properties":{"label":{"type":"string","description":"A human readable label for the field.","example":"What is your hometown?"},"tag":{"type":"string","description":"The ID used to reference the field in your emails.","example":"Hometown"},"type":{"type":"string","description":"The type of the field.","example":"choice_single","enum":["choice_single","choice_multiple"]},"choices":{"type":"array","description":"An array of choices for the field.","items":{"type":"string"},"example":["One","Two"]},"fallback":{"type":["string",null],"description":"A default value for the field, used in campaigns when there is no other value available.","example":"Unknown"}},"required":["label","tag","type","choices"]}]}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"],"default":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Bad request."},"status":{"type":"string","description":"Response status.","default":400},"errors":{"type":"array","items":{"type":"object","required":["detail"],"properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the value in the request document that caused the error.","default":"name"},"parameter":{"type":"string","description":"Name of the url parameter containing the error.","default":"list_id"},"detail":{"type":"string","description":"Error description.","default":"This value should be between 1 and 100."}}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"404":{"description":"Resource not found.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#not-found"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource not found."},"status":{"type":"string","description":"Response status.","default":404}}}}}},"409":{"description":"Conflict.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#conflict"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource already exists."},"status":{"type":"string","description":"Response status.","default":409}}}}}},"422":{"description":"Unprocessable content.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#unprocessable-content"},"title":{"type":"string","description":"General error title: `An error occurred.`","example":"An error occurred."},"detail":{"type":"string","description":"Error description: `Unprocessable content.`","example":"Unprocessable content."},"status":{"type":"string","description":"Response status: `422`","example":422},"errors":{"type":"array","description":"Validation errors","items":{"type":"object","properties":{"detail":{"type":"string","description":"Error description."},"pointer":{"type":"string","description":"A JSON Pointer
|
|
| /\"https:\/\/datatracker.ietf.org\/doc\/html\/rfc7807\" |
[RFC 7807]<\/a> to the value in the request document that caused the error."}},"example":{"detail":"This value must be string type, int provided.","pointer":"\/tag"}}}}}}}}},"summary":"Update field","description":"","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"},{"name":"tag","in":"path","description":"A unique identifier for a field.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"Hometown"}],"requestBody":{"description":"","content":{"application\/json":{"schema":{"title":"Text, number or date field","description":"A field that accepts a single value.","type":"object","properties":{"label":{"type":"string","description":"A human readable label for the field.","example":"What is your hometown?"},"tag":{"type":"string","description":"The ID used to reference the field in your emails.","example":"Hometown"},"type":{"type":"string","description":"The type of the field.","example":"text","enum":["text","number","date"]},"fallback":{"type":["string",null],"description":"A default value for the field, used in campaigns when there is no other value available.","example":"Unknown"}},"required":["label","tag","type"]}}},"required":false}},"delete":{"operationId":"api_lists_list_idfields_tag_delete","tags":["Field"],"responses":{"204":{"description":"No content."},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title: `An error occurred.`","example":"An error occurred."},"detail":{"type":"string","description":"Error description: `Bad request.`","example":"Bad request."},"status":{"type":"string","description":"Response status: `400`","example":400},"errors":{"type":"array","description":"Validation errors","items":{"type":"object","properties":{"detail":{"type":"string","description":"Error description."},"parameter":{"type":"string","description":"Name of the url parameter containing the error."}},"example":{"detail":"This value is not a valid UUID.","parameter":"list_id"}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"404":{"description":"Resource not found.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#not-found"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource not found."},"status":{"type":"string","description":"Response status.","default":404}}}}}}},"summary":"Delete field","description":"","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"},{"name":"tag","in":"path","description":"A unique identifier for a field.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"Hometown"}]}},"\/lists":{"get":{"operationId":"api_lists_get","tags":["List"],"responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/List.collection-get"}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"],"default":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Bad request."},"status":{"type":"string","description":"Response status.","default":400},"errors":{"type":"array","items":{"type":"object","required":["detail"],"properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the value in the request document that caused the error.","default":"name"},"parameter":{"type":"string","description":"Name of the url parameter containing the error.","default":"list_id"},"detail":{"type":"string","description":"Error description.","default":"This value should be between 1 and 100."}}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}}},"summary":"Get all lists","description":"","parameters":[{"name":"limit","in":"query","description":"Max number of results per page.","required":false,"deprecated":false,"schema":{"type":"integer","default":"100"},"style":"form","explode":true,"example":"100"},{"name":"starting_after","in":"query","description":"Cursor that points to the end of the page.","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":true,"example":"WyIyMDI0LTEyLTA3VDE1OjAzOjAxKzAwOjAwIiwiNDYzN2RmYTAtYjZmMC0xMWVmLWFjZDYtZjU5YjA4MDFlMjBkIl0"}]},"post":{"operationId":"api_lists_post","tags":["List"],"responses":{"201":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/List-get"}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"],"default":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Bad request."},"status":{"type":"string","description":"Response status.","default":400},"errors":{"type":"array","items":{"type":"object","required":["detail"],"properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the value in the request document that caused the error.","default":"name"},"parameter":{"type":"string","description":"Name of the url parameter containing the error.","default":"list_id"},"detail":{"type":"string","description":"Error description.","default":"This value should be between 1 and 100."}}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"422":{"description":"Unprocessable content.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#unprocessable-content"},"title":{"type":"string","description":"General error title: `An error occurred.`","example":"An error occurred."},"detail":{"type":"string","description":"Error description: `Unprocessable content.`","example":"Unprocessable content."},"status":{"type":"string","description":"Response status: `422`","example":422},"errors":{"type":"array","description":"Validation errors","items":{"type":"object","properties":{"detail":{"type":"string","description":"Error description."},"pointer":{"type":"string","description":"A JSON Pointer
|
|
| /\"https:\/\/datatracker.ietf.org\/doc\/html\/rfc7807\" |
[RFC 7807]<\/a> to the value in the request document that caused the error."}},"example":{"detail":"This value must be string type, int provided.","pointer":"\/name"}}}}}}}}},"summary":"Create list","description":"","parameters":[],"requestBody":{"description":"","content":{"application\/json":{"schema":{"type":"object","description":"","required":["name"],"properties":{"name":{"type":"string","description":"The name of the list.","example":"New clients list","maxLength":255}}}}},"required":false}}},"\/lists\/{list_id}":{"get":{"operationId":"api_lists_list_id_get","tags":["List"],"responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/List-get"}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title: `An error occurred.`","example":"An error occurred."},"detail":{"type":"string","description":"Error description: `Bad request.`","example":"Bad request."},"status":{"type":"string","description":"Response status: `400`","example":400},"errors":{"type":"array","description":"Validation errors","items":{"type":"object","properties":{"detail":{"type":"string","description":"Error description."},"parameter":{"type":"string","description":"Name of the url parameter containing the error."}},"example":{"detail":"This value is not a valid UUID.","parameter":"list_id"}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"404":{"description":"Resource not found.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#not-found"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource not found."},"status":{"type":"string","description":"Response status.","default":404}}}}}}},"summary":"Get list","description":"","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"}]},"put":{"operationId":"api_lists_list_id_put","tags":["List"],"responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/List-get"}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title: `An error occurred.`","example":"An error occurred."},"detail":{"type":"string","description":"Error description: `Bad request.`","example":"Bad request."},"status":{"type":"string","description":"Response status: `400`","example":400},"errors":{"type":"array","description":"Validation errors","items":{"type":"object","properties":{"detail":{"type":"string","description":"Error description."},"parameter":{"type":"string","description":"Name of the url parameter containing the error."}},"example":{"detail":"This value is not a valid UUID.","parameter":"list_id"}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"404":{"description":"Resource not found.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#not-found"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource not found."},"status":{"type":"string","description":"Response status.","default":404}}}}}},"422":{"description":"Unprocessable content.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#unprocessable-content"},"title":{"type":"string","description":"General error title: `An error occurred.`","example":"An error occurred."},"detail":{"type":"string","description":"Error description: `Unprocessable content.`","example":"Unprocessable content."},"status":{"type":"string","description":"Response status: `422`","example":422},"errors":{"type":"array","description":"Validation errors","items":{"type":"object","properties":{"detail":{"type":"string","description":"Error description."},"pointer":{"type":"string","description":"A JSON Pointer
|
|
| /\"https:\/\/datatracker.ietf.org\/doc\/html\/rfc7807\" |
[RFC 7807]<\/a> to the value in the request document that caused the error."}},"example":{"detail":"This value must be string type, int provided.","pointer":"\/name"}}}}}}}}},"summary":"Update list","description":"","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"}],"requestBody":{"description":"","content":{"application\/json":{"schema":{"type":"object","description":"","required":["name"],"properties":{"name":{"type":"string","description":"The name of the list.","example":"New clients list","maxLength":255}}}}},"required":false}},"delete":{"operationId":"api_lists_list_id_delete","tags":["List"],"responses":{"204":{"description":"No content."},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title: `An error occurred.`","example":"An error occurred."},"detail":{"type":"string","description":"Error description: `Bad request.`","example":"Bad request."},"status":{"type":"string","description":"Response status: `400`","example":400},"errors":{"type":"array","description":"Validation errors","items":{"type":"object","properties":{"detail":{"type":"string","description":"Error description."},"parameter":{"type":"string","description":"Name of the url parameter containing the error."}},"example":{"detail":"This value is not a valid UUID.","parameter":"list_id"}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"404":{"description":"Resource not found.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#not-found"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource not found."},"status":{"type":"string","description":"Response status.","default":404}}}}}}},"summary":"Delete a list","description":"","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"}]}},"\/lists\/{list_id}\/tags":{"get":{"operationId":"api_lists_list_idtags_get","tags":["Tag"],"responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/List.tags.collection-get"}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"],"default":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Bad request."},"status":{"type":"string","description":"Response status.","default":400},"errors":{"type":"array","items":{"type":"object","required":["detail"],"properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the value in the request document that caused the error.","default":"name"},"parameter":{"type":"string","description":"Name of the url parameter containing the error.","default":"list_id"},"detail":{"type":"string","description":"Error description.","default":"This value should be between 1 and 100."}}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"404":{"description":"Resource not found.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#not-found"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource not found."},"status":{"type":"string","description":"Response status.","default":404}}}}}}},"summary":"Get all tags","description":"","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"},{"name":"limit","in":"query","description":"Max number of results per page.","required":false,"deprecated":false,"schema":{"type":"integer","default":"100"},"style":"form","explode":true,"example":"100"},{"name":"starting_after","in":"query","description":"Cursor that points to the end of the page.","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":true,"example":"WyIyMDI0LTEyLTEwVDEzOjIxOjQ2KzAwOjAwIiwxXQ"}]},"post":{"operationId":"api_lists_list_idtags_post","tags":["Tag"],"responses":{"201":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ListTag"}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"],"default":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Bad request."},"status":{"type":"string","description":"Response status.","default":400},"errors":{"type":"array","items":{"type":"object","required":["detail"],"properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the value in the request document that caused the error.","default":"name"},"parameter":{"type":"string","description":"Name of the url parameter containing the error.","default":"list_id"},"detail":{"type":"string","description":"Error description.","default":"This value should be between 1 and 100."}}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"404":{"description":"Resource not found.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#not-found"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource not found."},"status":{"type":"string","description":"Response status.","default":404}}}}}},"409":{"description":"Conflict.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#conflict"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource already exists."},"status":{"type":"string","description":"Response status.","default":409}}}}}},"422":{"description":"Unprocessable content.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unprocessable-content"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Unprocessable content."},"status":{"type":"string","description":"Response status.","default":422},"errors":{"type":"array","items":{"type":"object","required":["detail"],"properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the value in the request document that caused the error.","default":"name"},"parameter":{"type":"string","description":"Name of the url parameter containing the error.","default":"list_id"},"detail":{"type":"string","description":"Error description.","default":"This value should be between 1 and 100."}}}}}}}}}},"summary":"Create tag","description":"","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"}],"requestBody":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ListTag"}}},"required":false}}},"\/lists\/{list_id}\/tags\/{tag}":{"put":{"operationId":"api_lists_list_idtags_tag_put","tags":["Tag"],"responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ListTag"}}}},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"],"default":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Bad request."},"status":{"type":"string","description":"Response status.","default":400},"errors":{"type":"array","items":{"type":"object","required":["detail"],"properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the value in the request document that caused the error.","default":"name"},"parameter":{"type":"string","description":"Name of the url parameter containing the error.","default":"list_id"},"detail":{"type":"string","description":"Error description.","default":"This value should be between 1 and 100."}}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"404":{"description":"Resource not found.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#not-found"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource not found."},"status":{"type":"string","description":"Response status.","default":404}}}}}},"409":{"description":"Conflict.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#conflict"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource already exists."},"status":{"type":"string","description":"Response status.","default":409}}}}}},"422":{"description":"Unprocessable content.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unprocessable-content"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Unprocessable content."},"status":{"type":"string","description":"Response status.","default":422},"errors":{"type":"array","items":{"type":"object","required":["detail"],"properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the value in the request document that caused the error.","default":"name"},"parameter":{"type":"string","description":"Name of the url parameter containing the error.","default":"list_id"},"detail":{"type":"string","description":"Error description.","default":"This value should be between 1 and 100."}}}}}}}}}},"summary":"Update tag","description":"","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"},{"name":"tag","in":"path","description":"A unique identifier for a field.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"Hometown"}],"requestBody":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ListTag"}}},"required":false}},"delete":{"operationId":"api_lists_list_idtags_tag_delete","tags":["Tag"],"responses":{"204":{"description":"No content."},"400":{"description":"Bad request.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"],"default":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request","example":"https:\/\/emailoctopus.com\/api-documentation\/v2#bad-request"},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Bad request."},"status":{"type":"string","description":"Response status.","default":400},"errors":{"type":"array","items":{"type":"object","required":["detail"],"properties":{"pointer":{"type":"string","description":"A JSON Pointer [RFC6901] to the value in the request document that caused the error.","default":"name"},"parameter":{"type":"string","description":"Name of the url parameter containing the error.","default":"list_id"},"detail":{"type":"string","description":"Error description.","default":"This value should be between 1 and 100."}}}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#unauthorized"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Invalid key."},"status":{"type":"string","description":"Response status.","default":401}}}}}},"403":{"description":"Access denied.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#access-denied"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Access denied."},"status":{"type":"string","description":"Response status.","default":403}}}}}},"404":{"description":"Resource not found.","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type.","enum":["https:\/\/emailoctopus.com\/api-documentation\/v2#not-found"]},"title":{"type":"string","description":"General error title.","default":"An error occurred."},"detail":{"type":"string","description":"Error description.","default":"Resource not found."},"status":{"type":"string","description":"Response status.","default":404}}}}}}},"summary":"Delete tag","description":"","parameters":[{"name":"list_id","in":"path","description":"The ID of the list.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"00000000-0000-0000-0000-000000000000"},{"name":"tag","in":"path","description":"A unique identifier for a field.","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false,"example":"Hometown"}]}}},"components":{"schemas":{"Automation":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the automation.","example":"00000000-0000-0000-0000-000000000000"},"contact_id":{"type":"string","description":"The ID of the contact.","example":"00000000-0000-0000-0000-000000000000"}}},"Campaign-get":{"type":"object","description":"Get details of a campaign.","properties":{"id":{"type":"string","description":"The ID of the campaign.","example":"00000000-0000-0000-0000-000000000000"},"status":{"type":"string","description":"The status of the campaign.","example":"draft","enum":["draft","sending","sent","error"]},"name":{"type":"string","description":"The name of the campaign.","example":"New clients campaign","maxLength":255},"subject":{"type":"string","description":"The subject of the campaign.","example":"Hello","maxLength":255},"to":{"type":"array","description":"The ids of the lists the campaign was sent to.","items":{"type":"string","example":["00000000-0000-0000-0000-000000000000"]}},"from":{"type":"object","description":"The sender of the campaign.","properties":{"name":{"type":"string","description":"The name the campaign was sent from.","example":"Otto Octopus"},"email_address":{"type":"string","description":"The email address the campaign was sent from.","example":"otto@example.com"}}},"content":{"type":"object","description":"The content of the campaign.","properties":{"html":{"type":"string","description":"The campaign's HTML content.","example":"<html>Foo Bar<\/html>"}}},"created_at":{"type":"string","description":"When the campaign was created, in ISO 8601 format.","example":"2015-12-01T12:59:37+00:00"},"sent_at":{"type":"string","description":"When the campaign was sent, in ISO 8601 format.","example":"2015-12-01T12:59:37+00:00"}}},"Campaign.collection":{"type":"object","description":"Get a collection of Campaign items.","properties":{"data":{"type":"array","description":"Collection of Campaign items.","items":{"$ref":"#\/components\/schemas\/Campaign-get"}},"paging":{"$ref":"#\/components\/schemas\/PagingResource"}}},"CampaignReportContact.collection-get.report":{"type":"object","description":"Get campaign contact reports.","properties":{"status":{"type":"string","description":"Event status.","example":"opened"},"data":{"type":"array","description":"Details.","items":{"type":"object","properties":{"contact_id":{"type":"string","description":"The ID of the contact.","example":"00000000-0000-0000-0000-000000000000"},"contact_email_address":{"type":"string","description":"The email address of the contact.","example":"otto@example.com"},"occurred_at":{"type":"string","description":"When the click occurred, in ISO 8601 format.","example":"2015-12-01T12:59:37+00:00"}}}},"paging":{"type":"object","properties":{"next":{"type":"object","properties":{"url":{"type":"string","description":"Next page url.","example":"https:\/\/api.emailoctopus.com\/campaigns\/00000000-0000-0000-0000-000000000000\/reports?status=opened&limit=10&starting_after=WzE3MjI5OTU4MDQwMDAsIjhkMDkxYTVhLTVhZDYtMTFlZi1iNmU4LTA1NjU4NDdhN2NkYSJd"},"starting_after":{"type":"string","description":"Cursor that points to the end of the page.","example":"WzE3MjI5OTU4MDQwMDAsIjhkMDkxYTVhLTVhZDYtMTFlZi1iNmU4LTA1NjU4NDdhN2NkYSJd"}}}}}}},"CampaignReportLink.collection-get":{"type":"object","description":"Get information on the performance of links in the campaign.","properties":{"data":{"type":"array","description":"Collection of Campaign items.","items":{"type":"object","properties":{"url":{"type":"string","description":"Next page url.","example":"https:\/\/example.com\/promo-1"},"clicked_total":{"type":"int","description":"The number of total clicks.","example":10},"clicked_unique":{"type":"int","description":"The number of unique clicks.","example":7}}}}}},"CampaignSummaryReport":{"type":"object","description":"Get a summary of the campaign.","properties":{"id":{"type":"string","description":"The ID of the campaign.","example":"00000000-0000-0000-0000-000000000000"},"sent":{"type":"int","description":"The number of contacts that were sent to.","example":200},"bounced":{"type":"object","description":"Statistics related to bounces.","properties":{"hard":{"type":"int","description":"The number of contacts who hard bounced.","example":10},"soft":{"type":"int","description":"The number of contacts who soft bounced.","example":5}}},"opened":{"type":"object","description":"Statistics related to opens.","properties":{"total":{"type":"int","description":"The number of all opens.","example":110},"unique":{"type":"int","description":"The number of unique opens.","example":85}}},"clicked":{"type":"object","description":"Statistics related to clicks.","properties":{"total":{"type":"int","description":"The number of all opens.","example":110},"unique":{"type":"int","description":"The number of unique opens.","example":85}}},"complained":{"type":"int","description":"The number of contacts who complained.","example":50},"unsubscribed":{"type":"int","description":"The number of contacts who unsubscribed.","example":25}}},"List-get":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the list.","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","description":"The name of the list.","example":"New clients list","maxLength":255},"double_opt_in":{"type":"boolean","description":"If double opt-in has been enabled on the list.","example":false},"fields":{"type":"array","description":"List of available fields","items":{"oneOf":[{"title":"Text, number or date field","description":"A field that accepts a single value.","type":"object","properties":{"label":{"type":"string","description":"A human readable label for the field.","example":"What is your hometown?"},"tag":{"type":"string","description":"The ID used to reference the field in your emails.","example":"Hometown"},"type":{"type":"string","description":"The type of the field.","example":"text","enum":["text","number","date"]},"fallback":{"type":["string",null],"description":"A default value for the field, used in campaigns when there is no other value available.","example":"Unknown"}},"required":["label","tag","type"]},{"title":"Choice field","description":"A field that accepts a single value from a list of choices.","type":"object","properties":{"label":{"type":"string","description":"A human readable label for the field.","example":"What is your hometown?"},"tag":{"type":"string","description":"The ID used to reference the field in your emails.","example":"Hometown"},"type":{"type":"string","description":"The type of the field.","example":"choice_single","enum":["choice_single","choice_multiple"]},"choices":{"type":"array","description":"An array of choices for the field.","items":{"type":"string"},"example":["One","Two"]},"fallback":{"type":["string",null],"description":"A default value for the field, used in campaigns when there is no other value available.","example":"Unknown"}},"required":["label","tag","type","choices"]}]}},"tags":{"type":"array","description":"The summary counts of the list.","items":{"type":"string","example":"welcome"}},"counts":{"type":"array","description":"The summary counts of the list.","items":{"type":"object","properties":{"pending":{"type":"integer","description":"The number of pending contacts in the list.","example":0},"subscribed":{"type":"integer","description":"The number of subscribed contacts in the list.","example":0},"unsubscribed":{"type":"integer","description":"The number of unsubscribed contacts in the list.","example":0}}}},"created_at":{"type":"string","description":"When the list was created, in ISO 8601 format.","example":"2015-12-01T12:59:37+00:00"},"last_updated_at":{"type":"string","description":"When the list was updated, in ISO 8601 format.","example":"2015-12-01T12:59:37+00:00"}},"required":["name"]},"List.collection-get":{"type":"object","description":"Get a collection of List items.","properties":{"data":{"type":"array","items":{"title":"List","$ref":"#\/components\/schemas\/List-get"}},"paging":{"$ref":"#\/components\/schemas\/PagingResource-get"}}},"List.contacts.collection-get":{"type":"object","properties":{"data":{"type":"array","description":"Collection of contacts.","items":{"$ref":"#\/components\/schemas\/ListContact-get"}},"paging":{"type":"object","properties":{"next":{"type":"object","properties":{"url":{"type":"string","description":"Next page url.","example":"https:\/\/api.emailoctopus.com\/lists\/00000000-0000-0000-0000-000000000000\/contacts?limit=10&starting_after=WzIsIjIwMjQtMDMtMTRUMTA6MTU6MjcrMDA6MDAiXQ"},"starting_after":{"type":"string","description":"Cursor that points to the end of the page.","example":"WzIsIjIwMjQtMDMtMTRUMTA6MTU6MjcrMDA6MDAiXQ"}}}}}}},"List.tags.collection-get":{"type":"object","properties":{"data":{"type":"array","description":"Collection of tags.","items":{"$ref":"#\/components\/schemas\/ListTag"}},"paging":{"type":"object","properties":{"next":{"type":"object","properties":{"url":{"type":"string","description":"Next page url.","example":"https:\/\/api.emailoctopus.com\/lists\/00000000-0000-0000-0000-000000000000\/tags?limit=10&starting_after=WzIsIjIwMjQtMDMtMTRUMTA6MTU6MjcrMDA6MDAiXQ"},"starting_after":{"type":"string","description":"Cursor that points to the end of the page.","example":"WzIsIjIwMjQtMDMtMTRUMTA6MTU6MjcrMDA6MDAiXQ"}}}}}}},"ListContact-get":{"type":"object","description":"Get details of a contact of a list.","properties":{"id":{"type":"string","description":"The ID of the contact.","example":"00000000-0000-0000-0000-000000000000"},"email_address":{"type":"string","description":"The email address of the contact.","example":"otto@example.com"},"fields":{"type":"object","description":"An object containing key\/value pairs of field values.","additionalProperties":{"description":"The value of the field.","x-additionalPropertiesName":"field tag","anyOf":[{"type":"string","title":"Text","description":"The value for a \"text\" field."},{"type":"integer","title":"Number","description":"The value for the \"number\" field."},{"type":"string","title":"Date","description":"The value for a \"date\" field."},{"type":"string","title":"Single Choice","description":"The value for a \"choice_single\" field."},{"type":"Array of strings","title":"Multiple Choice","description":"The value for a \"choice_multiple\" field."}]},"example":{"referral":"Otto","birthday":"2015-12-01","how_many_pets":2}},"tags":{"type":"array","description":"An array of tags associated with the contact.","items":{"type":"string","example":"vip"}},"status":{"type":"string","description":"The status of the contact.","example":"subscribed","enum":["pending","subscribed","unsubscribed"]},"created_at":{"type":"string","description":"When the contact was created, in ISO 8601 format.","example":"2015-12-01T12:59:37+00:00"},"last_updated_at":{"type":"string","description":"When the contact was last updated, in ISO 8601 format.","example":"2015-12-01T12:59:37+00:00"}},"required":["email_address"]},"ListContactBatch-put":{"type":"object","properties":{"contacts":{"type":"array","items":{"$ref":"#\/components\/schemas\/ListContactBatchItemResource-put"}}}},"ListContactBatchItemResource-put":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the contact.","example":"00000000-0000-0000-0000-000000000000"},"email_address":{"type":"string","description":"The email address of the contact.","example":"otto@example.com"},"fields":{"type":"object","description":"An object containing key\/value pairs of field values.","additionalProperties":{"description":"The value of the field.","x-additionalPropertiesName":"field tag","anyOf":[{"type":"string","title":"Text","description":"The value for a \"text\" field."},{"type":"integer","title":"Number","description":"The value for the \"number\" field."},{"type":"string","title":"Date","description":"The value for a \"date\" field."},{"type":"string","title":"Single Choice","description":"The value for a \"choice_single\" field."},{"type":"Array of strings","title":"Multiple Choice","description":"The value for a \"choice_multiple\" field."}]},"example":{"referral":"Otto","birthday":"2015-12-01","how_many_pets":2}},"tags":{"type":"object","description":"An object containing key\/value pairs, where the key is the tag name and the value is true to add the tag or false to remove it. Tags that are not referenced in the object will not be updated.","additionalProperties":{"type":"boolean"},"example":{"vip":true,"tagToRemove":false}},"status":{"type":"string","description":"The status of the contact.","example":"subscribed","enum":["pending","subscribed","unsubscribed"]}}},"ListField":{"type":"object","properties":{"label":{"type":"string","description":"A human readable label for the field.","example":"What is your hometown?"},"tag":{"type":"string","description":"The ID used to reference the field in your emails.","example":"Hometown"},"type":{"type":"string","description":"The type of the field.","example":"text","enum":["text","number","date"]},"choices":{"type":"array","description":"An array of choices for the field.","items":{"type":"string"},"example":["One","Two"]},"fallback":{"type":["string",null],"description":"A default value for the field, used in campaigns when there is no other value available.","example":"Unknown"}}},"ListTag":{"type":"object","properties":{"tag":{"type":"string","description":"The name of the tag.","example":"my tag"}}},"PagingNextResource":{"type":"object","properties":{"url":{"type":"string","description":"Next page url.","example":"https:\/\/api.emailoctopus.com\/lists?limit=10&starting_after=WyJiOWYyNjA5OC1kZjcxLTExZWUtOTQ4Zi00Yjc0NTg4MjVjYzAiXQ"},"starting_after":{"type":"string","description":"Cursor that points to the end of the page.","example":"WyJiOWYyNjA5OC1kZjcxLTExZWUtOTQ4Zi00Yjc0NTg4MjVjYzAiXQ"}}},"PagingNextResource-get":{"type":"object","properties":{"url":{"type":"string","description":"Next page url.","example":"https:\/\/api.emailoctopus.com\/lists?limit=10&starting_after=WyJiOWYyNjA5OC1kZjcxLTExZWUtOTQ4Zi00Yjc0NTg4MjVjYzAiXQ"},"starting_after":{"type":"string","description":"Cursor that points to the end of the page.","example":"WyJiOWYyNjA5OC1kZjcxLTExZWUtOTQ4Zi00Yjc0NTg4MjVjYzAiXQ"}}},"PagingResource":{"type":"object","properties":{"next":{"$ref":"#\/components\/schemas\/PagingNextResource"}}},"PagingResource-get":{"type":"object","properties":{"next":{"$ref":"#\/components\/schemas\/PagingNextResource-get"}}}},"responses":{},"parameters":{},"examples":{},"requestBodies":{},"headers":{},"securitySchemes":{"api_key":{"type":"http","description":"You can obtain your API key at https:\/\/api.emailoctopus.com\/developer\/api-keys\/create","name":"Authorization","in":"header","scheme":"bearer"}}},"security":[{"api_key":[]}],"tags":[{"name":"Automation","description":"An automation is a sequence of automated steps triggered by an event, such as when a contact subscribes to a list or is tagged.\nAutomations allow you to automatically send emails, update fields, apply tags and more.\n"},{"name":"Campaign","description":"A campaign is generally used to send a one-off, timely email to some or all of your subscribers. For example you may use a campaign to send the latest edition of your weekly newsletter, or to announce a new feature in your product.\n"},{"name":"Contact","description":"A contact represents an individual person within a list. For instance someone who has subscribed to your weekly newsletter.\nContacts contain essential information such as their email address, name and any additional data you have collected.\nContacts can also have tags, participate in automations and receive campaigns.\n"},{"name":"Field","description":"Fields are custom data points associated with contacts within a specific list.\nYou can create additional fields to capture specific information about your contacts, such as birthday, location, age or dietary preferences. These fields can be useful for sending more personalised and targeted emails.\n"},{"name":"List","description":"A list is a collection of contacts. Every one of your contacts will exist inside a list. The majority of our users only require one list, but multiple lists can be created and configured with different fields and tags in order to organise distinct groups of contacts.\n"},{"name":"Tag","description":"Tags are list-specific labels that you can assign to contacts to categorise or segment them. Tags allow you to create personalised campaigns or trigger automations based on specific attributes or behaviours.\n"}],"webhooks":{}}</html>
|
|
Внешние ссылки
Не найдено
Ссылки на сторонние сайты
?
Исходящие внешние ссылки передают часть ссылочного веса на чужие сайты. Ссылки на авторитетные ресурсы безопасны; ссылки на мусорные сайты могут навредить репутации страницы.
Внешних ссылок на странице не найдено.
Конкуренты Готовность: 0%
Конкуренты в Яндексе
Кол-во: 0
Топ сайтов-конкурентов в Яндексе
?
Сайты, чаще всего появляющиеся в ТОПе Яндекса по запросам из семантического ядра этой страницы.
Мы не нашли у вас конкурентов в Яндексе. Сайт или очень молодой или плохо продвигается.
Конкурентов в ТОП-10 Яндекса не нашлось.
Конкуренты в Google
Кол-во: 0
Топ сайтов-конкурентов в Google
?
Сайты, чаще всего появляющиеся в ТОПе Google по запросам из семантического ядра этой страницы.
Конкуренты в Google тоже не найдены. Займитесь продвижением сайта!
Конкурентов в ТОП-10 Google не нашлось.
ЗоЗПП: права потребителей Готовность: 100%
Нарушения
Не выявлены
Признаков дистанционной продажи товаров (интернет-магазина) не обнаружено — требования ЗоЗПП о раскрытии информации продавца к сайту не применяются. Нарушений нет.
ФЗ-149: рекомендательные технологии Готовность: 100%
Нарушения
Не выявлены
Рекомендательные блоки («с этим покупают», «похожие товары» и т.п.) на сайте не обнаружены — требования ст. 10.7 ФЗ-149 к сайту не применяются. Нарушений нет.
ФЗ-38: реклама Готовность: 100%
Нарушения
Не выявлены
Рекламных тематик с обязательными оговорками (медицина, БАД, кредиты и займы, новостройки) на сайте не обнаружено. Нарушений нет.
ФЗ-436: защита детей Готовность: 100%
Нарушения
Не выявлены
Признаков информационной продукции (новости, видео, книги, игры, курсы) не обнаружено — обязательная возрастная маркировка по ФЗ-436 сайту не требуется. Нарушений нет.
Вердикт
Страница https://emailoctopus.com/api-documentation/v2 готова к продвижению на 48%. Чтобы еще улучшить страницу и попасть на первые места поисковой выдачи необходимо:
Исправьте ошибки в мета-тегах.
Исправьте ошибки оптимизации.
Поделитесь с друзьями: