MailchimpTransactional::TransactionalApi
All URIs are relative to https://mandrillapp.com/api/1.0
| Method | HTTP request | Description |
|---|---|---|
| post_exports_activity | POST /exports/activity | /exports/activity |
| post_exports_info | POST /exports/info | /exports/info |
| post_exports_list | POST /exports/list | /exports/list |
| post_exports_rejects | POST /exports/rejects | /exports/rejects |
| post_exports_whitelist | POST /exports/whitelist | /exports/whitelist |
| post_inbound_add_domain | POST /inbound/add-domain | /inbound/add-domain |
| post_inbound_add_route | POST /inbound/add-route | /inbound/add-route |
| post_inbound_check_domain | POST /inbound/check-domain | /inbound/check-domain |
| post_inbound_delete_domain | POST /inbound/delete-domain | /inbound/delete-domain |
| post_inbound_delete_route | POST /inbound/delete-route | /inbound/delete-route |
| post_inbound_domains | POST /inbound/domains | /inbound/domains |
| post_inbound_routes | POST /inbound/routes | /inbound/routes |
| post_inbound_send_raw | POST /inbound/send-raw | /inbound/send-raw |
| post_inbound_update_route | POST /inbound/update-route | /inbound/update-route |
| post_ips_cancel_warmup | POST /ips/cancel-warmup | /ips/cancel-warmup |
| post_ips_check_custom_dns | POST /ips/check-custom-dns | /ips/check-custom-dns |
| post_ips_create_pool | POST /ips/create-pool | /ips/create-pool |
| post_ips_delete | POST /ips/delete | /ips/delete |
| post_ips_delete_pool | POST /ips/delete-pool | /ips/delete-pool |
| post_ips_info | POST /ips/info | /ips/info |
| post_ips_list | POST /ips/list | /ips/list |
| post_ips_list_pools | POST /ips/list-pools | /ips/list-pools |
| post_ips_pool_info | POST /ips/pool-info | /ips/pool-info |
| post_ips_provision | POST /ips/provision | /ips/provision |
| post_ips_set_custom_dns | POST /ips/set-custom-dns | /ips/set-custom-dns |
| post_ips_set_pool | POST /ips/set-pool | /ips/set-pool |
| post_ips_start_warmup | POST /ips/start-warmup | /ips/start-warmup |
| post_messages_cancel_scheduled | POST /messages/cancel-scheduled | /messages/cancel-scheduled |
| post_messages_content | POST /messages/content | /messages/content |
| post_messages_info | POST /messages/info | /messages/info |
| post_messages_list_scheduled | POST /messages/list-scheduled | /messages/list-scheduled |
| post_messages_parse | POST /messages/parse | /messages/parse |
| post_messages_reschedule | POST /messages/reschedule | /messages/reschedule |
| post_messages_search | POST /messages/search | /messages/search |
| post_messages_search_time_series | POST /messages/search-time-series | /messages/search-time-series |
| post_messages_send | POST /messages/send | /messages/send |
| post_messages_send_raw | POST /messages/send-raw | /messages/send-raw |
| post_messages_send_template | POST /messages/send-template | /messages/send-template |
| post_metadata_add | POST /metadata/add | /metadata/add |
| post_metadata_delete | POST /metadata/delete | /metadata/delete |
| post_metadata_list | POST /metadata/list | /metadata/list |
| post_metadata_update | POST /metadata/update | /metadata/update |
| post_rejects_add | POST /rejects/add | /rejects/add |
| post_rejects_delete | POST /rejects/delete | /rejects/delete |
| post_rejects_list | POST /rejects/list | /rejects/list |
| post_senders_add_domain | POST /senders/add-domain | /senders/add-domain |
| post_senders_check_domain | POST /senders/check-domain | /senders/check-domain |
| post_senders_domains | POST /senders/domains | /senders/domains |
| post_senders_info | POST /senders/info | /senders/info |
| post_senders_list | POST /senders/list | /senders/list |
| post_senders_time_series | POST /senders/time-series | /senders/time-series |
| post_senders_verify_domain | POST /senders/verify-domain | /senders/verify-domain |
| post_subaccounts_add | POST /subaccounts/add | /subaccounts/add |
| post_subaccounts_delete | POST /subaccounts/delete | /subaccounts/delete |
| post_subaccounts_info | POST /subaccounts/info | /subaccounts/info |
| post_subaccounts_list | POST /subaccounts/list | /subaccounts/list |
| post_subaccounts_pause | POST /subaccounts/pause | /subaccounts/pause |
| post_subaccounts_resume | POST /subaccounts/resume | /subaccounts/resume |
| post_subaccounts_update | POST /subaccounts/update | /subaccounts/update |
| post_tags_all_time_series | POST /tags/all-time-series | /tags/all-time-series |
| post_tags_delete | POST /tags/delete | /tags/delete |
| post_tags_info | POST /tags/info | /tags/info |
| post_tags_list | POST /tags/list | /tags/list |
| post_tags_time_series | POST /tags/time-series | /tags/time-series |
| post_templates_add | POST /templates/add | /templates/add |
| post_templates_delete | POST /templates/delete | /templates/delete |
| post_templates_info | POST /templates/info | /templates/info |
| post_templates_list | POST /templates/list | /templates/list |
| post_templates_publish | POST /templates/publish | /templates/publish |
| post_templates_render | POST /templates/render | /templates/render |
| post_templates_time_series | POST /templates/time-series | /templates/time-series |
| post_templates_update | POST /templates/update | /templates/update |
| post_urls_add_tracking_domain | POST /urls/add-tracking-domain | /urls/add-tracking-domain |
| post_urls_check_tracking_domain | POST /urls/check-tracking-domain | /urls/check-tracking-domain |
| post_urls_list | POST /urls/list | /urls/list |
| post_urls_search_deprecated | POST /urls/search | /urls/search (deprecated) |
| post_urls_time_series | POST /urls/time-series | /urls/time-series |
| post_urls_tracking_domains | POST /urls/tracking-domains | /urls/tracking-domains |
| post_users_info | POST /users/info | /users/info |
| post_users_ping | POST /users/ping | /users/ping |
| post_users_ping2 | POST /users/ping2 | /users/ping2 |
| post_users_senders | POST /users/senders | /users/senders |
| post_webhooks_add | POST /webhooks/add | /webhooks/add |
| post_webhooks_delete | POST /webhooks/delete | /webhooks/delete |
| post_webhooks_info | POST /webhooks/info | /webhooks/info |
| post_webhooks_list | POST /webhooks/list | /webhooks/list |
| post_webhooks_update | POST /webhooks/update | /webhooks/update |
| post_whitelists_add | POST /whitelists/add | /whitelists/add |
| post_whitelists_delete | POST /whitelists/delete | /whitelists/delete |
| post_whitelists_list | POST /whitelists/list | /whitelists/list |
post_exports_activity
InlineResponse2004 post_exports_activity(body)
/exports/activity
Begins an export of your activity history. The activity will be exported to a zip archive containing a single file named activity.csv in the same format as you would be able to export from your account's activity view. It includes the following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom metadata fields, they will be included in the exported data.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body4.new # Body4 |
begin
#/exports/activity
result = api_instance.post_exports_activity(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_exports_activity: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body4 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_exports_info
InlineResponse200 post_exports_info(body)
/exports/info
Returns information about an export job. If the export job's state is 'complete', the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body.new # Body |
begin
#/exports/info
result = api_instance.post_exports_info(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_exports_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_exports_list
Array<InlineResponse2001> post_exports_list(body)
/exports/list
Returns a list of your exports.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body1.new # Body1 |
begin
#/exports/list
result = api_instance.post_exports_list(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_exports_list: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body1 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_exports_rejects
InlineResponse2002 post_exports_rejects(body)
/exports/rejects
Begins an export of your rejection blacklist. The blacklist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body2.new # Body2 |
begin
#/exports/rejects
result = api_instance.post_exports_rejects(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_exports_rejects: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body2 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_exports_whitelist
InlineResponse2003 post_exports_whitelist(body)
/exports/whitelist
Begins an export of your rejection whitelist. The whitelist will be exported to a zip archive containing a single file named whitelist.csv that includes the following fields: email, detail, created_at.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body3.new # Body3 |
begin
#/exports/whitelist
result = api_instance.post_exports_whitelist(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_exports_whitelist: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body3 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_inbound_add_domain
InlineResponse2006 post_inbound_add_domain(body)
/inbound/add-domain
Add a new template
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body6.new # Body6 |
begin
#/inbound/add-domain
result = api_instance.post_inbound_add_domain(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_inbound_add_domain: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body6 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_inbound_add_route
InlineResponse20010 post_inbound_add_route(body)
/inbound/add-route
Add a new mailbox route to an inbound domain
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body10.new # Body10 |
begin
#/inbound/add-route
result = api_instance.post_inbound_add_route(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_inbound_add_route: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body10 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_inbound_check_domain
InlineResponse2007 post_inbound_check_domain(body)
/inbound/check-domain
Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body7.new # Body7 |
begin
#/inbound/check-domain
result = api_instance.post_inbound_check_domain(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_inbound_check_domain: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body7 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_inbound_delete_domain
InlineResponse2008 post_inbound_delete_domain(body)
/inbound/delete-domain
Delete an inbound domain from the account. All mail will stop routing for this domain immediately.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body8.new # Body8 |
begin
#/inbound/delete-domain
result = api_instance.post_inbound_delete_domain(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_inbound_delete_domain: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body8 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_inbound_delete_route
InlineResponse20012 post_inbound_delete_route(body)
/inbound/delete-route
Delete an existing inbound mailbox route
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body12.new # Body12 |
begin
#/inbound/delete-route
result = api_instance.post_inbound_delete_route(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_inbound_delete_route: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body12 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_inbound_domains
Array<InlineResponse2005> post_inbound_domains(body)
/inbound/domains
Add an inbound domain to your account
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body5.new # Body5 |
begin
#/inbound/domains
result = api_instance.post_inbound_domains(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_inbound_domains: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body5 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_inbound_routes
Array<InlineResponse2009> post_inbound_routes(body)
/inbound/routes
List the mailbox routes defined for an inbound domain
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body9.new # Body9 |
begin
#/inbound/routes
result = api_instance.post_inbound_routes(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_inbound_routes: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body9 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_inbound_send_raw
Array<InlineResponse20013> post_inbound_send_raw(body)
/inbound/send-raw
Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body13.new # Body13 |
begin
#/inbound/send-raw
result = api_instance.post_inbound_send_raw(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_inbound_send_raw: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body13 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_inbound_update_route
InlineResponse20011 post_inbound_update_route(body)
/inbound/update-route
Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body11.new # Body11 |
begin
#/inbound/update-route
result = api_instance.post_inbound_update_route(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_inbound_update_route: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body11 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_ips_cancel_warmup
InlineResponse20017 post_ips_cancel_warmup(body)
/ips/cancel-warmup
Cancels the warmup process for a dedicated IP.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body18.new # Body18 |
begin
#/ips/cancel-warmup
result = api_instance.post_ips_cancel_warmup(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_ips_cancel_warmup: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body18 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_ips_check_custom_dns
InlineResponse20023 post_ips_check_custom_dns(body)
/ips/check-custom-dns
Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body25.new # Body25 |
begin
#/ips/check-custom-dns
result = api_instance.post_ips_check_custom_dns(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_ips_check_custom_dns: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body25 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_ips_create_pool
InlineResponse20021 post_ips_create_pool(body)
/ips/create-pool
Creates a pool and returns it. If a pool already exists with this name, no action will be performed.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body23.new # Body23 |
begin
#/ips/create-pool
result = api_instance.post_ips_create_pool(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_ips_create_pool: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body23 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_ips_delete
InlineResponse20019 post_ips_delete(body)
/ips/delete
Deletes a dedicated IP. This is permanent and cannot be undone.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body20.new # Body20 |
begin
#/ips/delete
result = api_instance.post_ips_delete(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_ips_delete: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body20 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_ips_delete_pool
InlineResponse20022 post_ips_delete_pool(body)
/ips/delete-pool
Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body24.new # Body24 |
begin
#/ips/delete-pool
result = api_instance.post_ips_delete_pool(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_ips_delete_pool: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body24 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_ips_info
InlineResponse20015 post_ips_info(body)
/ips/info
Retrieves information about a single dedicated ip.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body15.new # Body15 |
begin
#/ips/info
result = api_instance.post_ips_info(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_ips_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body15 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_ips_list
Array<InlineResponse20014> post_ips_list(body)
/ips/list
Lists your dedicated IPs.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body14.new # Body14 |
begin
#/ips/list
result = api_instance.post_ips_list(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_ips_list: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body14 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_ips_list_pools
Array<InlineResponse20020> post_ips_list_pools(body)
/ips/list-pools
Lists your dedicated IP pools.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body21.new # Body21 |
begin
#/ips/list-pools
result = api_instance.post_ips_list_pools(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_ips_list_pools: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body21 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_ips_pool_info
InlineResponse20021 post_ips_pool_info(body)
/ips/pool-info
Describes a single dedicated IP pool.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body22.new # Body22 |
begin
#/ips/pool-info
result = api_instance.post_ips_pool_info(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_ips_pool_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body22 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_ips_provision
InlineResponse20016 post_ips_provision(body)
/ips/provision
Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body16.new # Body16 |
begin
#/ips/provision
result = api_instance.post_ips_provision(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_ips_provision: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body16 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_ips_set_custom_dns
InlineResponse20024 post_ips_set_custom_dns(body)
/ips/set-custom-dns
Configures the custom DNS name for a dedicated IP.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body26.new # Body26 |
begin
#/ips/set-custom-dns
result = api_instance.post_ips_set_custom_dns(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_ips_set_custom_dns: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body26 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_ips_set_pool
InlineResponse20018 post_ips_set_pool(body)
/ips/set-pool
Moves a dedicated IP to a different pool.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body19.new # Body19 |
begin
#/ips/set-pool
result = api_instance.post_ips_set_pool(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_ips_set_pool: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body19 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_ips_start_warmup
InlineResponse20017 post_ips_start_warmup(body)
/ips/start-warmup
Begins the warmup process for a dedicated IP. During the warmup process, Mandrill will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body17.new # Body17 |
begin
#/ips/start-warmup
result = api_instance.post_ips_start_warmup(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_ips_start_warmup: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body17 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_messages_cancel_scheduled
Array<InlineResponse20032> post_messages_cancel_scheduled(body)
/messages/cancel-scheduled
Queries your scheduled emails.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body36.new # Body36 |
begin
#/messages/cancel-scheduled
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_messages_cancel_scheduled: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body36 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_messages_content
InlineResponse20030 post_messages_content(body)
/messages/content
Get the full content of a recently sent message
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body32.new # Body32 |
begin
#/messages/content
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_messages_content: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body32 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_messages_info
InlineResponse20029 post_messages_info(body)
/messages/info
Get the information for a single recently sent message
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body31.new # Body31 |
begin
#/messages/info
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_messages_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body31 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_messages_list_scheduled
Array<InlineResponse20032> post_messages_list_scheduled(body)
/messages/list-scheduled
Queries your scheduled emails.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body35.new # Body35 |
begin
#/messages/list-scheduled
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_messages_list_scheduled: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body35 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_messages_parse
InlineResponse20031 post_messages_parse(body)
/messages/parse
Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body33.new # Body33 |
begin
#/messages/parse
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_messages_parse: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body33 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_messages_reschedule
Array<InlineResponse20032> post_messages_reschedule(body)
/messages/reschedule
Queries your scheduled emails.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body37.new # Body37 |
begin
#/messages/reschedule
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_messages_reschedule: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body37 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_messages_search
Array<InlineResponse20027> post_messages_search(body)
/messages/search
Search recently sent messages and optionally narrow by date range, tags, senders, and API keys. If no date range is specified, results within the last 7 days are returned. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body29.new # Body29 |
begin
#/messages/search
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_messages_search: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body29 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_messages_search_time_series
Array<InlineResponse20028> post_messages_search_time_series(body)
/messages/search-time-series
Search the content of recently sent messages and return the aggregated hourly stats for matching messages
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body30.new # Body30 |
begin
#/messages/search-time-series
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_messages_search_time_series: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body30 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_messages_send
Array<InlineResponse20025> post_messages_send(body)
/messages/send
Send a new transactional message through Mandrill
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body27.new # Body27 |
begin
#/messages/send
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_messages_send: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body27 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_messages_send_raw
Object post_messages_send_raw(body)
/messages/send-raw
Take a raw MIME document for a message, and send it exactly as if it were sent through Mandrill's SMTP servers
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body34.new # Body34 |
begin
#/messages/send-raw
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_messages_send_raw: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body34 |
Return type
Object
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_messages_send_template
Array<InlineResponse20026> post_messages_send_template(body)
/messages/send-template
Send a new transactional message through Mandrill
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body28.new # Body28 |
begin
#/messages/send-template
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_messages_send_template: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body28 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_metadata_add
InlineResponse20034 post_metadata_add(body)
/metadata/add
Add a new custom metadata field to be indexed for the account.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body39.new # Body39 |
begin
#/metadata/add
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_metadata_add: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body39 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_metadata_delete
InlineResponse20036 post_metadata_delete(body)
/metadata/delete
Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body41.new # Body41 |
begin
#/metadata/delete
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_metadata_delete: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body41 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_metadata_list
Array<InlineResponse20033> post_metadata_list(body)
/metadata/list
Get the list of custom metadata fields indexed for the account.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body38.new # Body38 |
begin
#/metadata/list
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_metadata_list: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body38 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_metadata_update
InlineResponse20035 post_metadata_update(body)
/metadata/update
Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body40.new # Body40 |
begin
#/metadata/update
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_metadata_update: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body40 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_rejects_add
InlineResponse20037 post_rejects_add(body)
/rejects/add
Adds an email to your email rejection blacklist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your blacklist. Attempting to blacklist an address that has been whitelisted will have no effect.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body42.new # Body42 |
begin
#/rejects/add
result = api_instance.post_rejects_add(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_rejects_add: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body42 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_rejects_delete
InlineResponse20039 post_rejects_delete(body)
/rejects/delete
Deletes an email rejection. There is no limit to how many rejections you can remove from your blacklist, but keep in mind that each deletion has an affect on your reputation.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body44.new # Body44 |
begin
#/rejects/delete
result = api_instance.post_rejects_delete(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_rejects_delete: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body44 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_rejects_list
Array<InlineResponse20038> post_rejects_list(body)
/rejects/list
Retrieves your email rejection blacklist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body43.new # Body43 |
begin
#/rejects/list
result = api_instance.post_rejects_list(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_rejects_list: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body43 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_senders_add_domain
InlineResponse20042 post_senders_add_domain(body)
/senders/add-domain
Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body47.new # Body47 |
begin
#/senders/add-domain
result = api_instance.post_senders_add_domain(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_senders_add_domain: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body47 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_senders_check_domain
InlineResponse20043 post_senders_check_domain(body)
/senders/check-domain
Checks the SPF and DKIM settings for a domain. If you haven't already added this domain to your account, it will be added automatically.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body48.new # Body48 |
begin
#/senders/check-domain
result = api_instance.post_senders_check_domain(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_senders_check_domain: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body48 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_senders_domains
Array<InlineResponse20041> post_senders_domains(body)
/senders/domains
Returns the sender domains that have been added to this account
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body46.new # Body46 |
begin
#/senders/domains
result = api_instance.post_senders_domains(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_senders_domains: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body46 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_senders_info
InlineResponse20045 post_senders_info(body)
/senders/info
Return more detailed information about a single sender, including aggregates of recent stats
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body50.new # Body50 |
begin
#/senders/info
result = api_instance.post_senders_info(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_senders_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body50 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_senders_list
Array<InlineResponse20040> post_senders_list(body)
/senders/list
Return the senders that have tried to use this account
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body45.new # Body45 |
begin
#/senders/list
result = api_instance.post_senders_list(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_senders_list: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body45 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_senders_time_series
Array<InlineResponse20046> post_senders_time_series(body)
/senders/time-series
Return the recent history (hourly stats for the last 30 days) for a sender
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body51.new # Body51 |
begin
#/senders/time-series
result = api_instance.post_senders_time_series(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_senders_time_series: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body51 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_senders_verify_domain
InlineResponse20044 post_senders_verify_domain(body)
/senders/verify-domain
Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Mandrill account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Mandrill accounts from sending mail signed by your domain.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body49.new # Body49 |
begin
#/senders/verify-domain
result = api_instance.post_senders_verify_domain(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_senders_verify_domain: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body49 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_subaccounts_add
InlineResponse20048 post_subaccounts_add(body)
/subaccounts/add
Add a new subaccount
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body53.new # Body53 |
begin
#/subaccounts/add
result = api_instance.post_subaccounts_add(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_subaccounts_add: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body53 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_subaccounts_delete
InlineResponse20051 post_subaccounts_delete(body)
/subaccounts/delete
Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body56.new # Body56 |
begin
#/subaccounts/delete
result = api_instance.post_subaccounts_delete(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_subaccounts_delete: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body56 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_subaccounts_info
InlineResponse20049 post_subaccounts_info(body)
/subaccounts/info
Given the ID of an existing subaccount, return the data about it
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body54.new # Body54 |
begin
#/subaccounts/info
result = api_instance.post_subaccounts_info(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_subaccounts_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body54 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_subaccounts_list
Array<InlineResponse20047> post_subaccounts_list(body)
/subaccounts/list
Get the list of subaccounts defined for the account, optionally filtered by a prefix
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body52.new # Body52 |
begin
#/subaccounts/list
result = api_instance.post_subaccounts_list(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_subaccounts_list: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body52 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_subaccounts_pause
InlineResponse20052 post_subaccounts_pause(body)
/subaccounts/pause
Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body57.new # Body57 |
begin
#/subaccounts/pause
result = api_instance.post_subaccounts_pause(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_subaccounts_pause: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body57 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_subaccounts_resume
InlineResponse20053 post_subaccounts_resume(body)
/subaccounts/resume
Resume a paused subaccount's sending
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body58.new # Body58 |
begin
#/subaccounts/resume
result = api_instance.post_subaccounts_resume(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_subaccounts_resume: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body58 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_subaccounts_update
InlineResponse20050 post_subaccounts_update(body)
/subaccounts/update
Update an existing subaccount
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body55.new # Body55 |
begin
#/subaccounts/update
result = api_instance.post_subaccounts_update(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_subaccounts_update: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body55 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_tags_all_time_series
Array<InlineResponse20028> post_tags_all_time_series(body)
/tags/all-time-series
Return the recent history (hourly stats for the last 30 days) for all tags
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body63.new # Body63 |
begin
#/tags/all-time-series
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_tags_all_time_series: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body63 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_tags_delete
InlineResponse20055 post_tags_delete(body)
/tags/delete
Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body60.new # Body60 |
begin
#/tags/delete
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_tags_delete: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body60 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_tags_info
InlineResponse20056 post_tags_info(body)
/tags/info
Return more detailed information about a single tag, including aggregates of recent stats
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body61.new # Body61 |
begin
#/tags/info
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_tags_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body61 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_tags_list
Array<InlineResponse20054> post_tags_list(body)
/tags/list
Return all of the user-defined tag information
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body59.new # Body59 |
begin
#/tags/list
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_tags_list: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body59 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_tags_time_series
Array<InlineResponse20028> post_tags_time_series(body)
/tags/time-series
Return the recent history (hourly stats for the last 30 days) for a tag
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body62.new # Body62 |
begin
#/tags/time-series
result = api_instance.(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_tags_time_series: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body62 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_templates_add
InlineResponse20057 post_templates_add(body)
/templates/add
Add a new template
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body64.new # Body64 |
begin
#/templates/add
result = api_instance.post_templates_add(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_templates_add: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body64 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_templates_delete
InlineResponse20061 post_templates_delete(body)
/templates/delete
Delete a template
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body68.new # Body68 |
begin
#/templates/delete
result = api_instance.post_templates_delete(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_templates_delete: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body68 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_templates_info
InlineResponse20058 post_templates_info(body)
/templates/info
Get the information for an existing template
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body65.new # Body65 |
begin
#/templates/info
result = api_instance.post_templates_info(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_templates_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body65 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_templates_list
Array<InlineResponse20062> post_templates_list(body)
/templates/list
Return a list of all the templates available to this user
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body69.new # Body69 |
begin
#/templates/list
result = api_instance.post_templates_list(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_templates_list: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body69 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_templates_publish
InlineResponse20060 post_templates_publish(body)
/templates/publish
Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body67.new # Body67 |
begin
#/templates/publish
result = api_instance.post_templates_publish(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_templates_publish: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body67 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_templates_render
InlineResponse20063 post_templates_render(body)
/templates/render
Inject content and optionally merge fields into a template, returning the HTML that results
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body71.new # Body71 |
begin
#/templates/render
result = api_instance.post_templates_render(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_templates_render: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body71 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_templates_time_series
Array<InlineResponse20046> post_templates_time_series(body)
/templates/time-series
Return the recent history (hourly stats for the last 30 days) for a template
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body70.new # Body70 |
begin
#/templates/time-series
result = api_instance.post_templates_time_series(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_templates_time_series: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body70 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_templates_update
InlineResponse20059 post_templates_update(body)
/templates/update
Update the code for an existing template. If null is provided for any fields, the values will remain unchanged.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body66.new # Body66 |
begin
#/templates/update
result = api_instance.post_templates_update(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_templates_update: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body66 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_urls_add_tracking_domain
InlineResponse20068 post_urls_add_tracking_domain(body)
/urls/add-tracking-domain
Add a tracking domain to your account
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body76.new # Body76 |
begin
#/urls/add-tracking-domain
result = api_instance.post_urls_add_tracking_domain(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_urls_add_tracking_domain: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body76 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_urls_check_tracking_domain
InlineResponse20068 post_urls_check_tracking_domain(body)
/urls/check-tracking-domain
Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body77.new # Body77 |
begin
#/urls/check-tracking-domain
result = api_instance.post_urls_check_tracking_domain(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_urls_check_tracking_domain: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body77 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_urls_list
Array<InlineResponse20064> post_urls_list(body)
/urls/list
Get the 100 most clicked URLs
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body72.new # Body72 |
begin
#/urls/list
result = api_instance.post_urls_list(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_urls_list: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body72 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_urls_search_deprecated
Array<InlineResponse20065> post_urls_search_deprecated(body)
/urls/search (deprecated)
Return the 100 most clicked URLs that match the search query given
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body73.new # Body73 |
begin
#/urls/search (deprecated)
result = api_instance.post_urls_search_deprecated(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_urls_search_deprecated: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body73 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_urls_time_series
Array<InlineResponse20066> post_urls_time_series(body)
/urls/time-series
Return the recent history (hourly stats for the last 30 days) for a url
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body74.new # Body74 |
begin
#/urls/time-series
result = api_instance.post_urls_time_series(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_urls_time_series: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body74 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_urls_tracking_domains
Array<InlineResponse20067> post_urls_tracking_domains(body)
/urls/tracking-domains
Get the list of tracking domains set up for this account
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body75.new # Body75 |
begin
#/urls/tracking-domains
result = api_instance.post_urls_tracking_domains(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_urls_tracking_domains: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body75 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_users_info
InlineResponse20069 post_users_info(body)
/users/info
Return the information about the API-connected user
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body78.new # Body78 |
begin
#/users/info
result = api_instance.post_users_info(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_users_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body78 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_users_ping
String post_users_ping(body)
/users/ping
Validate an API key and respond to a ping
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body79.new # Body79 |
begin
#/users/ping
result = api_instance.post_users_ping(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_users_ping: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body79 |
Return type
String
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_users_ping2
InlineResponse20070 post_users_ping2(body)
/users/ping2
Validate an API key and respond to a ping (anal JSON parser version)
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body80.new # Body80 |
begin
#/users/ping2
result = api_instance.post_users_ping2(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_users_ping2: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body80 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_users_senders
Array<InlineResponse20040> post_users_senders(body)
/users/senders
Return the senders that have tried to use this account, both verified and unverified
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body81.new # Body81 |
begin
#/users/senders
result = api_instance.post_users_senders(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_users_senders: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body81 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_webhooks_add
InlineResponse20072 post_webhooks_add(body)
/webhooks/add
Add a new webhook
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body83.new # Body83 |
begin
#/webhooks/add
result = api_instance.post_webhooks_add(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_webhooks_add: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body83 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_webhooks_delete
InlineResponse20075 post_webhooks_delete(body)
/webhooks/delete
Delete an existing webhook
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body86.new # Body86 |
begin
#/webhooks/delete
result = api_instance.post_webhooks_delete(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_webhooks_delete: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body86 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_webhooks_info
InlineResponse20073 post_webhooks_info(body)
/webhooks/info
Given the ID of an existing webhook, return the data about it
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body84.new # Body84 |
begin
#/webhooks/info
result = api_instance.post_webhooks_info(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_webhooks_info: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body84 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_webhooks_list
Array<InlineResponse20071> post_webhooks_list(body)
/webhooks/list
Get the list of all webhooks defined on the account
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body82.new # Body82 |
begin
#/webhooks/list
result = api_instance.post_webhooks_list(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_webhooks_list: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body82 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_webhooks_update
InlineResponse20074 post_webhooks_update(body)
/webhooks/update
Update an existing webhook
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body85.new # Body85 |
begin
#/webhooks/update
result = api_instance.post_webhooks_update(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_webhooks_update: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body85 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_whitelists_add
InlineResponse20076 post_whitelists_add(body)
/whitelists/add
Adds an email to your email rejection whitelist. If the address is currently on your blacklist, that blacklist entry will be removed automatically.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body87.new # Body87 |
begin
#/whitelists/add
result = api_instance.post_whitelists_add(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_whitelists_add: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body87 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_whitelists_delete
InlineResponse20078 post_whitelists_delete(body)
/whitelists/delete
Removes an email address from the whitelist.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body89.new # Body89 |
begin
#/whitelists/delete
result = api_instance.post_whitelists_delete(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_whitelists_delete: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body89 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
post_whitelists_list
Array<InlineResponse20077> post_whitelists_list(body)
/whitelists/list
Retrieves your email rejection whitelist. You can provide an email address or search prefix to limit the results. Returns up to 1000 results.
Example
# load the gem
require 'mailchimp_transactional'
api_instance = MailchimpTransactional::TransactionalApi.new
body = MailchimpTransactional::Body88.new # Body88 |
begin
#/whitelists/list
result = api_instance.post_whitelists_list(body)
p result
rescue MailchimpTransactional::ApiError => e
puts "Exception when calling TransactionalApi->post_whitelists_list: #{e}"
end
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Body88 |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json