{"openapi":"3.0.0","info":{"description":"Email marketing platform API — campaigns, groups, subscribers, A/B tests, SMTP (Mailrelay)","version":null},"servers":[{"description":"Email marketing platform API — campaigns, groups, subscribers, A/B tests, SMTP (Mailrelay)","url":"https://api.apirails.com/mailrelay"}],"paths":{"/ab_tests":{"get":{"tags":["A B Tests"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[campaign_id_eq]","in":"query","description":"Search: The campaign ID that will be used as a base for this A/B test equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[campaign_id_gteq]","in":"query","description":"Search: The campaign ID that will be used as a base for this A/B test greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[campaign_id_lteq]","in":"query","description":"Search: The campaign ID that will be used as a base for this A/B test less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","campaign_id"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ab_tests"},"summary":"Lists A/B tests","description":"Lists A/B tests — Lists A/B tests.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 100. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your parameters. ","security":[{"bearerAuth":[]}]},"post":{"tags":["A B Tests"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ab_tests"},"summary":"Add a new A/B test","description":"Add a new A/B test — Add a new A/B test. At least <strong>10</strong> subscribers are required to send it. You have to choose the percentage of the subscribers that will receive the A/B test. Example: if you use <strong>20%</strong>, <strong>10%</strong> will receive combination A and <strong>10%</strong> will receive combination B. After the winning combination is selected, <strong>80%</strong> of the subscribers will receive it. It's also possible to perform an A/B test with 3 combinations. In","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"campaign_id":{"type":"number","description":"campaign_id (body parameter)","required":true},"decide_with":{"type":"string","description":"decide_with (body parameter)","required":true,"enum":["manual","clicks","impressions"]},"group_ids":{"type":"array","description":"group_ids (body parameter)","items":{"type":"number"}},"number_of_combinations":{"type":"number","description":"number_of_combinations (body parameter)"},"percentage":{"type":"number","description":"percentage (body parameter)","required":true},"segment_id":{"type":"number","description":"segment_id (body parameter)"},"sender_a_id":{"type":"number","description":"sender_a_id (body parameter)"},"sender_b_id":{"type":"number","description":"sender_b_id (body parameter)"},"sender_c_id":{"type":"number","description":"sender_c_id (body parameter)"},"subject_a":{"type":"string","description":"subject_a (body parameter)"},"subject_b":{"type":"string","description":"subject_b (body parameter)"},"subject_c":{"type":"string","description":"subject_c (body parameter)"},"target":{"type":"string","description":"target (body parameter)","enum":["groups","segment"]},"test_type":{"type":"string","description":"test_type (body parameter)","required":true,"enum":["subject","sender"]},"wait_time":{"type":"number","description":"wait_time (body parameter)"},"wait_unit":{"type":"string","description":"wait_unit (body parameter)","enum":["hours","days"]}}},"example":{"campaign_id":1,"decide_with":"manual","group_ids":[],"number_of_combinations":1,"percentage":1,"segment_id":1,"sender_a_id":1,"sender_b_id":1,"sender_c_id":1,"subject_a":"subject_a_value","subject_b":"subject_b_value","subject_c":"subject_c_value","target":"groups","test_type":"subject","wait_time":1,"wait_unit":"hours"}}}}}},"/ab_tests/{id}":{"get":{"tags":["A B Tests"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ab_tests/{id}"},"summary":"Get an A/B test by id","description":"Get an A/B test by id","security":[{"bearerAuth":[]}]},"delete":{"tags":["A B Tests"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ab_tests/{id}"},"summary":"Remove an A/B test","description":"Remove an A/B test — Remove an A/B test.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ab_tests/{id}/cancel":{"patch":{"tags":["A B Tests"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ab_tests/{id}/cancel"},"summary":"Cancel A/B test","description":"Cancel A/B test — Cancel A/B test. Once you cancel it, it can't be resumed.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ab_tests/{id}/choose_winning_combination":{"post":{"tags":["A B Tests"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ab_tests/{id}/choose_winning_combination"},"summary":"Choose which A/B test combination should to be sent to the remaining subscribers","description":"Choose which A/B test combination should to be sent to the remaining subscribers — When A/B test is manual, this method allows you to select which option should be sent to the remaining subscribers. Once you select it, we will start sending it immediately.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"combination":{"type":"string","description":"combination (body parameter)","required":true}}},"example":{"combination":"combination_value"}}}}}},"/ab_tests/{id}/set_as_manual":{"patch":{"tags":["A B Tests"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ab_tests/{id}/set_as_manual"},"summary":"Set A/B test as manual","description":"Set A/B test as manual — Change an existing A/B test to manual.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api_batches":{"get":{"tags":["API Batches"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: Id equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: Id greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: Id less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","status"]}}},{"name":"q[status_cont]","in":"query","description":"Search: Status contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_eq]","in":"query","description":"Search: Status equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/api_batches"},"summary":"Lists API batches","description":"Lists API batches — You can use API batches to process multiple API requests in a single request. You can specify up to 500 operations in the same batch.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two H","security":[{"bearerAuth":[]}]},"post":{"tags":["API Batches"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/api_batches"},"summary":"Add a new API batch","description":"Add a new API batch — Use this method create a new API batch. You can specify up to 500 operations in the same batch. This an example showing how to create a group, update a subscriber and pause a sent campaign in the same API batch: ``` { \"callback_url\": \"https://my-callback-url.example.com/\", \"operations_attributes\": [{ \"request_path\": \"/api/v1/groups\", \"request_method\": \"post\", \"request_body\": \"{\\\"name\\\":\\\"My group name\\\"}\" }, { \"request_path\": \"/api/v1/subscribers/1\", \"request_method\": \"patc","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"callback_url":{"type":"string","description":"callback_url (body parameter)"},"operations_attributes":{"type":"array","description":"operations_attributes (body parameter)","required":true,"items":{"type":"object","properties":{"operation_id":{"type":"string","description":"operation_id (body parameter)"},"request_body":{"type":"string","description":"request_body (body parameter)"},"request_headers":{"type":"string","description":"request_headers (body parameter)"},"request_method":{"type":"string","description":"request_method (body parameter)","required":true},"request_path":{"type":"string","description":"request_path (body parameter)","required":true}}}}}},"example":{"callback_url":"callback_url_value","operations_attributes":[]}}}}}},"/api_batches/{id}":{"get":{"tags":["API Batches"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"include_operations","in":"query","description":"Include operations in the results","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/api_batches/{id}"},"summary":"Get an API batch by id","description":"Get an API batch by id","security":[{"bearerAuth":[]}]}},"/bounces":{"delete":{"tags":["Bounces"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/bounces"},"summary":"Delete bounces","description":"Delete bounces — Delete one or more bounced emails. This will remove the emails from the bounces list and reactivate the subscriber, allowing emails to be sent again.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emails":{"type":"array","description":"emails (body parameter)","required":true,"items":{"type":"string"}}}},"example":{"emails":[]}}}}}},"/campaign_folders":{"get":{"tags":["Campaign Folders"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[name_cont]","in":"query","description":"Search: Name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_eq]","in":"query","description":"Search: Name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","name"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/campaign_folders"},"summary":"Lists campaign folders","description":"Lists campaign folders — Lists campaign folders.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on yo","security":[{"bearerAuth":[]}]},"post":{"tags":["Campaign Folders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/campaign_folders"},"summary":"Add a new campaign folder","description":"Add a new campaign folder","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"name (body parameter)","required":true}}},"example":{"name":"name_value"}}}}}},"/campaign_folders/{id}":{"get":{"tags":["Campaign Folders"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/campaign_folders/{id}"},"summary":"Get a campaign folder by id","description":"Get a campaign folder by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["Campaign Folders"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/campaign_folders/{id}"},"summary":"Update a campaign folder","description":"Update a campaign folder","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"name (body parameter)"}}},"example":{"name":"name_value"}}}}},"delete":{"tags":["Campaign Folders"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/campaign_folders/{id}"},"summary":"Remove a campaign folder","description":"Remove a campaign folder","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/campaigns":{"get":{"tags":["Campaigns"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[campaign_folder_id_eq]","in":"query","description":"Search: Campaign folder equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[campaign_folder_id_gteq]","in":"query","description":"Search: Campaign folder greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[campaign_folder_id_lteq]","in":"query","description":"Search: Campaign folder less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[created_at_eq]","in":"query","description":"Search: Created at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_gteq]","in":"query","description":"Search: Created at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_lteq]","in":"query","description":"Search: Created at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[html_cont]","in":"query","description":"Search: HTML contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[html_eq]","in":"query","description":"Search: HTML equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","subject","sender_id","campaign_folder_id","segment_id","html","target","created_at","updated_at"]}}},{"name":"q[segment_id_eq]","in":"query","description":"Search: Segment id. This is required if target is set to segment equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[segment_id_gteq]","in":"query","description":"Search: Segment id. This is required if target is set to segment greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[segment_id_lteq]","in":"query","description":"Search: Segment id. This is required if target is set to segment less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[sender_id_eq]","in":"query","description":"Search: Sender equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[sender_id_gteq]","in":"query","description":"Search: Sender greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[sender_id_lteq]","in":"query","description":"Search: Sender less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[subject_cont]","in":"query","description":"Search: Subject contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[subject_eq]","in":"query","description":"Search: Subject equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[target_cont]","in":"query","description":"Search: Allows you to specify to whom this campaign will be sent contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[target_eq]","in":"query","description":"Search: Allows you to specify to whom this campaign will be sent equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_eq]","in":"query","description":"Search: Updated at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_gteq]","in":"query","description":"Search: Updated at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_lteq]","in":"query","description":"Search: Updated at less than or equal to","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/campaigns"},"summary":"Lists campaigns","description":"Lists campaigns — Lists campaigns.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 100. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your parameters. ","security":[{"bearerAuth":[]}]},"post":{"tags":["Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/campaigns"},"summary":"Add a new campaign","description":"Add a new campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"analytics_utm_campaign":{"type":"string","description":"analytics_utm_campaign (body parameter)"},"campaign_folder_id":{"type":"number","description":"campaign_folder_id (body parameter)"},"group_ids":{"type":"array","description":"group_ids (body parameter)","items":{"type":"number"}},"html":{"type":"string","description":"html (body parameter)","required":true},"preview_text":{"type":"string","description":"preview_text (body parameter)"},"reply_to":{"type":"string","description":"reply_to (body parameter)"},"segment_id":{"type":"number","description":"segment_id (body parameter)"},"sender_id":{"type":"number","description":"sender_id (body parameter)","required":true},"subject":{"type":"string","description":"subject (body parameter)","required":true},"target":{"type":"string","description":"target (body parameter)","required":true,"enum":["groups","segment"]},"track_clicks":{"type":"boolean","description":"track_clicks (body parameter)","enum":[true,false]},"track_opens":{"type":"boolean","description":"track_opens (body parameter)","enum":[true,false]},"url_token":{"type":"boolean","description":"url_token (body parameter)","enum":[true,false]},"use_premailer":{"type":"boolean","description":"use_premailer (body parameter)","enum":[true,false]}}},"example":{"analytics_utm_campaign":"analytics_utm_campaign_value","campaign_folder_id":1,"group_ids":[],"html":"html_value","preview_text":"preview_text_value","reply_to":"reply_to_value","segment_id":1,"sender_id":1,"subject":"subject_value","target":"groups","track_clicks":true,"track_opens":true,"url_token":true,"use_premailer":true}}}}}},"/campaigns/{id}":{"get":{"tags":["Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/campaigns/{id}"},"summary":"Get a campaign by id","description":"Get a campaign by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/campaigns/{id}"},"summary":"Update a campaign","description":"Update a campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"analytics_utm_campaign":{"type":"string","description":"analytics_utm_campaign (body parameter)"},"campaign_folder_id":{"type":"number","description":"campaign_folder_id (body parameter)"},"group_ids":{"type":"array","description":"group_ids (body parameter)","items":{"type":"number"}},"html":{"type":"string","description":"html (body parameter)"},"preview_text":{"type":"string","description":"preview_text (body parameter)"},"reply_to":{"type":"string","description":"reply_to (body parameter)"},"segment_id":{"type":"number","description":"segment_id (body parameter)"},"sender_id":{"type":"number","description":"sender_id (body parameter)"},"subject":{"type":"string","description":"subject (body parameter)"},"target":{"type":"string","description":"target (body parameter)","enum":["groups","segment"]},"track_clicks":{"type":"boolean","description":"track_clicks (body parameter)","enum":[true,false]},"track_opens":{"type":"boolean","description":"track_opens (body parameter)","enum":[true,false]},"url_token":{"type":"boolean","description":"url_token (body parameter)","enum":[true,false]},"use_premailer":{"type":"boolean","description":"use_premailer (body parameter)","enum":[true,false]}}},"example":{"analytics_utm_campaign":"analytics_utm_campaign_value","campaign_folder_id":1,"group_ids":[],"html":"html_value","preview_text":"preview_text_value","reply_to":"reply_to_value","segment_id":1,"sender_id":1,"subject":"subject_value","target":"groups","track_clicks":true,"track_opens":true,"url_token":true,"use_premailer":true}}}}},"delete":{"tags":["Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/campaigns/{id}"},"summary":"Remove a campaign","description":"Remove a campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/campaigns/{id}/send_all":{"post":{"tags":["Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/campaigns/{id}/send_all"},"summary":"Send a campaign","description":"Send a campaign — This method is used to send a campaign to groups or a specific segment. It will return some attributes, including the ID of the sent campaign which can be used to check the progress and results of the campaign. If you specify a callback URL, we will send a POST request right after the sent campaign is processed. It will contain a JSON with the type of the callback and the ID of the sent campaign. You can use the following command to simulate a callback request: ``` curl --reque","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"callback_url":{"type":"string","description":"callback_url (body parameter)"},"group_ids":{"type":"array","description":"group_ids (body parameter)","items":{"type":"number"}},"scheduled_at":{"type":"string","description":"scheduled_at (body parameter)"},"segment_id":{"type":"number","description":"segment_id (body parameter)"},"target":{"type":"string","description":"target (body parameter)","required":true,"enum":["groups","segment"]}}},"example":{"callback_url":"callback_url_value","group_ids":[],"scheduled_at":"scheduled_at_value","segment_id":1,"target":"groups"}}}}}},"/campaigns/{id}/send_test":{"post":{"tags":["Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/campaigns/{id}/send_test"},"summary":"Send a campaign to test emails","description":"Send a campaign to test emails — This method is used to send a campaign to test emails. It's useful to test your newsletter before sending it to your subscribers","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"test_emails":{"type":"string","description":"test_emails (body parameter)","required":true}}},"example":{"test_emails":"test_emails_value"}}}}}},"/custom_fields":{"get":{"tags":["Custom Fields"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[field_type_cont]","in":"query","description":"Search: Field type contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[field_type_eq]","in":"query","description":"Search: Field type equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[label_cont]","in":"query","description":"Search: Label contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[label_eq]","in":"query","description":"Search: Label equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[required_not_true]","in":"query","description":"Search: Required is false","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[required_true]","in":"query","description":"Search: Required is true","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","field_type","label","tag_name","required"]}}},{"name":"q[tag_name_cont]","in":"query","description":"Search: Tag name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[tag_name_eq]","in":"query","description":"Search: Tag name equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/custom_fields"},"summary":"Lists custom fields","description":"Lists custom fields — Lists custom fields.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your par","security":[{"bearerAuth":[]}]},"post":{"tags":["Custom Fields"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/custom_fields"},"summary":"Add a new custom field","description":"Add a new custom field","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"custom_field_options_attributes":{"type":"array","description":"custom_field_options_attributes (body parameter)","items":{"type":"object","properties":{"label":{"type":"string","description":"label (body parameter)","required":true}}}},"default_value":{"type":"string","description":"default_value (body parameter)"},"field_type":{"type":"string","description":"field_type (body parameter)","required":true,"enum":["text","textarea","number","select","select_multiple","checkbox","radio_buttons","date"]},"label":{"type":"string","description":"label (body parameter)","required":true},"required":{"type":"boolean","description":"required (body parameter)","enum":[true,false]},"tag_name":{"type":"string","description":"tag_name (body parameter)","required":true}}},"example":{"custom_field_options_attributes":[],"default_value":"default_value_value","field_type":"text","label":"label_value","required":true,"tag_name":"tag_name_value"}}}}}},"/custom_fields/{id}":{"get":{"tags":["Custom Fields"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/custom_fields/{id}"},"summary":"Get a custom field by id","description":"Get a custom field by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["Custom Fields"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/custom_fields/{id}"},"summary":"Update a custom field","description":"Update a custom field — In order to update an existing custom field option, you must provide the id of the field. If you don't provide an id, it will create a new option. If you want to remove an option, provide the id and an attribute called _destroy. Example: ``` [ { id: 9, _destroy: true } ] ``` This would remove the custom field option with id 9.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"custom_field_options_attributes":{"type":"array","description":"custom_field_options_attributes (body parameter)","items":{"type":"object","properties":{"_destroy":{"type":"boolean","description":"_destroy (body parameter)","enum":[true,false]},"id":{"type":"number","description":"id (body parameter)"},"label":{"type":"string","description":"label (body parameter)","required":true}}}},"default_value":{"type":"string","description":"default_value (body parameter)"},"label":{"type":"string","description":"label (body parameter)"},"required":{"type":"boolean","description":"required (body parameter)","enum":[true,false]},"tag_name":{"type":"string","description":"tag_name (body parameter)"}}},"example":{"custom_field_options_attributes":[],"default_value":"default_value_value","label":"label_value","required":true,"tag_name":"tag_name_value"}}}}},"delete":{"tags":["Custom Fields"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/custom_fields/{id}"},"summary":"Remove a custom field","description":"Remove a custom field — ***Important!*** Deleting a custom field will remove this field's data from all subscribers.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ecommerce/stores/{store_id}/carts":{"get":{"tags":["Ecommerce Carts"],"parameters":[{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[cart_id_cont]","in":"query","description":"Search: Cart contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[cart_id_eq]","in":"query","description":"Search: Cart equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_eq]","in":"query","description":"Search: Created at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_gteq]","in":"query","description":"Search: Created at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_lteq]","in":"query","description":"Search: Created at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"cart_id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["cart_id","status","created_at","updated_at"]}}},{"name":"q[status_cont]","in":"query","description":"Search: Status contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_eq]","in":"query","description":"Search: Status equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_eq]","in":"query","description":"Search: Updated at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_gteq]","in":"query","description":"Search: Updated at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_lteq]","in":"query","description":"Search: Updated at less than or equal to","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/carts"},"summary":"Lists carts","description":"Lists carts — Lists carts.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your parameters. You can","security":[{"bearerAuth":[]}]},"post":{"tags":["Ecommerce Carts"],"parameters":[{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/carts"},"summary":"Add a new cart","description":"Add a new cart","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cart_id":{"type":"string","description":"cart_id (body parameter)","required":true},"cart_items_attributes":{"type":"array","description":"cart_items_attributes (body parameter)","items":{"type":"object","properties":{"cart_item_id":{"type":"string","description":"cart_item_id (body parameter)","required":true},"price":{"type":"number","description":"price (body parameter)","required":true},"product_variant_id":{"type":"string","description":"product_variant_id (body parameter)","required":true},"quantity":{"type":"number","description":"quantity (body parameter)","required":true}}}},"checkout_url":{"type":"string","description":"checkout_url (body parameter)"},"email":{"type":"string","description":"email (body parameter)"},"status":{"type":"string","description":"status (body parameter)","required":true,"enum":["pending","completed"]},"tax_total":{"type":"number","description":"tax_total (body parameter)"},"total":{"type":"number","description":"total (body parameter)","required":true}}},"example":{"cart_id":"cart_id_value","cart_items_attributes":[],"checkout_url":"checkout_url_value","email":"email_value","status":"pending","tax_total":1,"total":1}}}}}},"/ecommerce/stores/{store_id}/carts/sync":{"post":{"tags":["Ecommerce Carts"],"parameters":[{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/carts/sync"},"summary":"Create or update a cart","description":"Create or update a cart — Automatically checks if cart exists based on cart_id parameter. If it does, it updates the cart. If it doesn't, it creates a new cart.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cart_id":{"type":"string","description":"cart_id (body parameter)","required":true},"cart_items_attributes":{"type":"array","description":"cart_items_attributes (body parameter)","items":{"type":"object","properties":{"cart_item_id":{"type":"string","description":"cart_item_id (body parameter)","required":true},"price":{"type":"number","description":"price (body parameter)","required":true},"product_variant_id":{"type":"string","description":"product_variant_id (body parameter)","required":true},"quantity":{"type":"number","description":"quantity (body parameter)","required":true}}}},"checkout_url":{"type":"string","description":"checkout_url (body parameter)"},"email":{"type":"string","description":"email (body parameter)"},"status":{"type":"string","description":"status (body parameter)","required":true,"enum":["pending","completed"]},"tax_total":{"type":"number","description":"tax_total (body parameter)"},"total":{"type":"number","description":"total (body parameter)","required":true}}},"example":{"cart_id":"cart_id_value","cart_items_attributes":[],"checkout_url":"checkout_url_value","email":"email_value","status":"pending","tax_total":1,"total":1}}}}}},"/ecommerce/stores/{store_id}/carts/{id}":{"get":{"tags":["Ecommerce Carts"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/carts/{id}"},"summary":"Get a cart by id","description":"Get a cart by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["Ecommerce Carts"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/carts/{id}"},"summary":"Update a cart","description":"Update a cart","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cart_id":{"type":"string","description":"cart_id (body parameter)"},"cart_items_attributes":{"type":"array","description":"cart_items_attributes (body parameter)","items":{"type":"object","properties":{"_destroy":{"type":"boolean","description":"_destroy (body parameter)","enum":[true,false]},"cart_item_id":{"type":"string","description":"cart_item_id (body parameter)"},"price":{"type":"number","description":"price (body parameter)"},"product_variant_id":{"type":"string","description":"product_variant_id (body parameter)"},"quantity":{"type":"number","description":"quantity (body parameter)"}}}},"checkout_url":{"type":"string","description":"checkout_url (body parameter)"},"email":{"type":"string","description":"email (body parameter)"},"status":{"type":"string","description":"status (body parameter)","enum":["pending","completed"]},"tax_total":{"type":"number","description":"tax_total (body parameter)"},"total":{"type":"number","description":"total (body parameter)"}}},"example":{"cart_id":"cart_id_value","cart_items_attributes":[],"checkout_url":"checkout_url_value","email":"email_value","status":"pending","tax_total":1,"total":1}}}}},"delete":{"tags":["Ecommerce Carts"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/carts/{id}"},"summary":"Remove a cart","description":"Remove a cart","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ecommerce/stores/{store_id}/product_categories":{"get":{"tags":["Ecommerce Product Categories"],"parameters":[{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[created_at_eq]","in":"query","description":"Search: Created at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_gteq]","in":"query","description":"Search: Created at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_lteq]","in":"query","description":"Search: Created at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_cont]","in":"query","description":"Search: Name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_eq]","in":"query","description":"Search: Name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[product_category_id_cont]","in":"query","description":"Search: Product category contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[product_category_id_eq]","in":"query","description":"Search: Product category equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"product_category_id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["product_category_id","name","created_at","updated_at"]}}},{"name":"q[updated_at_eq]","in":"query","description":"Search: Updated at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_gteq]","in":"query","description":"Search: Updated at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_lteq]","in":"query","description":"Search: Updated at less than or equal to","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/product_categories"},"summary":"Lists product categories","description":"Lists product categories — Lists product categories.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based o","security":[{"bearerAuth":[]}]},"post":{"tags":["Ecommerce Product Categories"],"parameters":[{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/product_categories"},"summary":"Add a new product category","description":"Add a new product category","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"name (body parameter)","required":true},"product_category_id":{"type":"string","description":"product_category_id (body parameter)","required":true}}},"example":{"name":"name_value","product_category_id":"product_category_id_value"}}}}}},"/ecommerce/stores/{store_id}/product_categories/sync":{"post":{"tags":["Ecommerce Product Categories"],"parameters":[{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/product_categories/sync"},"summary":"Create or update a product category","description":"Create or update a product category — Automatically checks if product category exists based on product_category_id parameter. If it does, it updates the product category. If it doesn't, it creates a new product category.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"name (body parameter)","required":true},"product_category_id":{"type":"string","description":"product_category_id (body parameter)","required":true}}},"example":{"name":"name_value","product_category_id":"product_category_id_value"}}}}}},"/ecommerce/stores/{store_id}/product_categories/{id}":{"get":{"tags":["Ecommerce Product Categories"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/product_categories/{id}"},"summary":"Get a product category by id","description":"Get a product category by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["Ecommerce Product Categories"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/product_categories/{id}"},"summary":"Update a product category","description":"Update a product category","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"name (body parameter)"},"product_category_id":{"type":"string","description":"product_category_id (body parameter)"}}},"example":{"name":"name_value","product_category_id":"product_category_id_value"}}}}},"delete":{"tags":["Ecommerce Product Categories"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/product_categories/{id}"},"summary":"Remove a product category from a store","description":"Remove a product category from a store","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ecommerce/stores/{store_id}/products":{"get":{"tags":["Ecommerce Products"],"parameters":[{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[created_at_eq]","in":"query","description":"Search: Created at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_gteq]","in":"query","description":"Search: Created at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_lteq]","in":"query","description":"Search: Created at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[image_url_cont]","in":"query","description":"Search: Image url contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[image_url_eq]","in":"query","description":"Search: Image url equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_cont]","in":"query","description":"Search: Name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_eq]","in":"query","description":"Search: Name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[product_id_cont]","in":"query","description":"Search: Product contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[product_id_eq]","in":"query","description":"Search: Product equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"product_id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["product_id","name","url","image_url","created_at","updated_at"]}}},{"name":"q[updated_at_eq]","in":"query","description":"Search: Updated at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_gteq]","in":"query","description":"Search: Updated at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_lteq]","in":"query","description":"Search: Updated at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[url_cont]","in":"query","description":"Search: Url contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[url_eq]","in":"query","description":"Search: Url equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/products"},"summary":"Lists products","description":"Lists products — Lists products.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your parameters. Y","security":[{"bearerAuth":[]}]},"post":{"tags":["Ecommerce Products"],"parameters":[{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/products"},"summary":"Add a new product","description":"Add a new product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"image_url":{"type":"string","description":"image_url (body parameter)"},"name":{"type":"string","description":"name (body parameter)","required":true},"product_id":{"type":"string","description":"product_id (body parameter)","required":true},"product_variants_attributes":{"type":"array","description":"product_variants_attributes (body parameter)","items":{"type":"object","properties":{"image_url":{"type":"string","description":"image_url (body parameter)"},"name":{"type":"string","description":"name (body parameter)","required":true},"price":{"type":"number","description":"price (body parameter)","required":true},"product_variant_id":{"type":"string","description":"product_variant_id (body parameter)","required":true},"sale_price":{"type":"number","description":"sale_price (body parameter)"},"sku":{"type":"string","description":"sku (body parameter)"},"url":{"type":"string","description":"url (body parameter)"}}}},"url":{"type":"string","description":"url (body parameter)"}}},"example":{"image_url":"image_url_value","name":"name_value","product_id":"product_id_value","product_variants_attributes":[],"url":"url_value"}}}}}},"/ecommerce/stores/{store_id}/products/sync":{"post":{"tags":["Ecommerce Products"],"parameters":[{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/products/sync"},"summary":"Create or update a product","description":"Create or update a product — Automatically checks if product exists based on product_id parameter. If it does, it updates the product. If it doesn't, it creates a new product.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"image_url":{"type":"string","description":"image_url (body parameter)"},"name":{"type":"string","description":"name (body parameter)","required":true},"product_id":{"type":"string","description":"product_id (body parameter)","required":true},"product_variants_attributes":{"type":"array","description":"product_variants_attributes (body parameter)","items":{"type":"object","properties":{"image_url":{"type":"string","description":"image_url (body parameter)"},"name":{"type":"string","description":"name (body parameter)","required":true},"price":{"type":"number","description":"price (body parameter)","required":true},"product_variant_id":{"type":"string","description":"product_variant_id (body parameter)","required":true},"sale_price":{"type":"number","description":"sale_price (body parameter)"},"sku":{"type":"string","description":"sku (body parameter)"},"url":{"type":"string","description":"url (body parameter)"}}}},"url":{"type":"string","description":"url (body parameter)"}}},"example":{"image_url":"image_url_value","name":"name_value","product_id":"product_id_value","product_variants_attributes":[],"url":"url_value"}}}}}},"/ecommerce/stores/{store_id}/products/{id}":{"get":{"tags":["Ecommerce Products"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/products/{id}"},"summary":"Get a product by id","description":"Get a product by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["Ecommerce Products"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/products/{id}"},"summary":"Update a product","description":"Update a product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"image_url":{"type":"string","description":"image_url (body parameter)"},"name":{"type":"string","description":"name (body parameter)"},"product_id":{"type":"string","description":"product_id (body parameter)"},"product_variants_attributes":{"type":"array","description":"product_variants_attributes (body parameter)","items":{"type":"object","properties":{"_destroy":{"type":"boolean","description":"_destroy (body parameter)","enum":[true,false]},"image_url":{"type":"string","description":"image_url (body parameter)"},"name":{"type":"string","description":"name (body parameter)"},"price":{"type":"number","description":"price (body parameter)"},"product_variant_id":{"type":"string","description":"product_variant_id (body parameter)"},"sale_price":{"type":"number","description":"sale_price (body parameter)"},"sku":{"type":"string","description":"sku (body parameter)"},"url":{"type":"string","description":"url (body parameter)"}}}},"url":{"type":"string","description":"url (body parameter)"}}},"example":{"image_url":"image_url_value","name":"name_value","product_id":"product_id_value","product_variants_attributes":[],"url":"url_value"}}}}},"delete":{"tags":["Ecommerce Products"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"store_id","in":"path","description":"ID of the store","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{store_id}/products/{id}"},"summary":"Remove a product","description":"Remove a product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ecommerce/stores":{"get":{"tags":["Ecommerce Stores"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[currency_cont]","in":"query","description":"Search: Currency contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[currency_eq]","in":"query","description":"Search: Currency equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: Id equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: Id greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: Id less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[name_cont]","in":"query","description":"Search: Name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_eq]","in":"query","description":"Search: Name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","name","currency"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores"},"summary":"Lists ecommerce stores","description":"Lists ecommerce stores — Lists ecommerce stores.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on yo","security":[{"bearerAuth":[]}]},"post":{"tags":["Ecommerce Stores"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores"},"summary":"Add a new ecommerce store","description":"Add a new ecommerce store","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"currency":{"type":"string","description":"currency (body parameter)","required":true},"name":{"type":"string","description":"name (body parameter)","required":true},"url":{"type":"string","description":"url (body parameter)"}}},"example":{"currency":"currency_value","name":"name_value","url":"url_value"}}}}}},"/ecommerce/stores/{id}":{"get":{"tags":["Ecommerce Stores"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{id}"},"summary":"Get an ecommerce store by id","description":"Get an ecommerce store by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["Ecommerce Stores"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{id}"},"summary":"Update an ecommerce store","description":"Update an ecommerce store","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"currency":{"type":"string","description":"currency (body parameter)"},"name":{"type":"string","description":"name (body parameter)"},"url":{"type":"string","description":"url (body parameter)"}}},"example":{"currency":"currency_value","name":"name_value","url":"url_value"}}}}},"delete":{"tags":["Ecommerce Stores"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ecommerce/stores/{id}"},"summary":"Remove an ecommerce store","description":"Remove an ecommerce store","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/event_subscriptions":{"get":{"tags":["Event Subscriptions"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[created_at_eq]","in":"query","description":"Search: Created at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_gteq]","in":"query","description":"Search: Created at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_lteq]","in":"query","description":"Search: Created at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[delivery_method_cont]","in":"query","description":"Search: Delivery method contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[delivery_method_eq]","in":"query","description":"Search: Delivery method equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[email_cont]","in":"query","description":"Search: Email contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[email_eq]","in":"query","description":"Search: Email equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[enabled_not_true]","in":"query","description":"Search: Enabled is false","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[enabled_true]","in":"query","description":"Search: Enabled is true","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[name_cont]","in":"query","description":"Search: Name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_eq]","in":"query","description":"Search: Name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","name","delivery_method","url","email","enabled","created_at","updated_at"]}}},{"name":"q[updated_at_eq]","in":"query","description":"Search: Updated at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_gteq]","in":"query","description":"Search: Updated at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_lteq]","in":"query","description":"Search: Updated at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[url_cont]","in":"query","description":"Search: URL contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[url_eq]","in":"query","description":"Search: URL equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/event_subscriptions"},"summary":"Lists event subscriptions","description":"Lists event subscriptions — Event subscriptions are used to receive notifications about events via webhook or email.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description |","security":[{"bearerAuth":[]}]},"post":{"tags":["Event Subscriptions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/event_subscriptions"},"summary":"Add a new event subscription","description":"Add a new event subscription — Add a new event subscription to receive notifications about events via webhook or email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"delivery_method":{"type":"string","description":"delivery_method (body parameter)","required":true,"enum":["email","webhook"]},"email":{"type":"string","description":"email (body parameter)"},"enabled":{"type":"boolean","description":"enabled (body parameter)","enum":[true,false]},"event_types":{"type":"array","description":"event_types (body parameter)","required":true,"items":{"type":"string"}},"http_headers":{"type":"object","description":"http_headers (body parameter)"},"name":{"type":"string","description":"name (body parameter)","required":true},"url":{"type":"string","description":"url (body parameter)"}}},"example":{"delivery_method":"email","email":"email_value","enabled":true,"event_types":[],"http_headers":{},"name":"name_value","url":"url_value"}}}}}},"/event_subscriptions/{id}":{"get":{"tags":["Event Subscriptions"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/event_subscriptions/{id}"},"summary":"Get an event subscription by id","description":"Get an event subscription by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["Event Subscriptions"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/event_subscriptions/{id}"},"summary":"Update an event subscription","description":"Update an event subscription","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"email (body parameter)"},"enabled":{"type":"boolean","description":"enabled (body parameter)","enum":[true,false]},"event_types":{"type":"array","description":"event_types (body parameter)","items":{"type":"string"}},"http_headers":{"type":"object","description":"http_headers (body parameter)"},"name":{"type":"string","description":"name (body parameter)"},"url":{"type":"string","description":"url (body parameter)"}}},"example":{"email":"email_value","enabled":true,"event_types":[],"http_headers":{},"name":"name_value","url":"url_value"}}}}},"delete":{"tags":["Event Subscriptions"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/event_subscriptions/{id}"},"summary":"Remove an event subscription","description":"Remove an event subscription","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/package":{"get":{"tags":["General"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/package"},"summary":"Get account package info","description":"Get account package info — This function can be used to retrieve information about your account's package.","security":[{"bearerAuth":[]}]}},"/ping":{"get":{"tags":["General"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/ping"},"summary":"Ping the API","description":"Ping the API — This method can be used to verify if the API key was sent and is valid.","security":[{"bearerAuth":[]}]}},"/stats":{"get":{"tags":["General"],"parameters":[{"name":"end_time","in":"query","description":"End time. Format: YYYY-MM-DD HH:MM:SS","required":true,"schema":{"type":"string","example":""}},{"name":"start_time","in":"query","description":"Start time. Format: YYYY-MM-DD HH:MM:SS","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/stats"},"summary":"Get stats summary","description":"Get stats summary — Return the stats summary for the given time range. The maximum time range is 1 month.","security":[{"bearerAuth":[]}]}},"/groups":{"get":{"tags":["Groups"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[name_cont]","in":"query","description":"Search: Name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_eq]","in":"query","description":"Search: Name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","name"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/groups"},"summary":"Lists groups","description":"Lists groups — Lists groups.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your parameters. You c","security":[{"bearerAuth":[]}]},"post":{"tags":["Groups"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/groups"},"summary":"Add a new group","description":"Add a new group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"description (body parameter)"},"name":{"type":"string","description":"name (body parameter)","required":true}}},"example":{"description":"description_value","name":"name_value"}}}}}},"/groups/{id}":{"get":{"tags":["Groups"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/groups/{id}"},"summary":"Get a group by id","description":"Get a group by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["Groups"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/groups/{id}"},"summary":"Update a group","description":"Update a group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"description (body parameter)"},"name":{"type":"string","description":"name (body parameter)"}}},"example":{"description":"description_value","name":"name_value"}}}}},"delete":{"tags":["Groups"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/groups/{id}"},"summary":"Remove a group","description":"Remove a group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/imports":{"get":{"tags":["Imports"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","status"]}}},{"name":"q[status_cont]","in":"query","description":"Search: Status contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_eq]","in":"query","description":"Search: Status equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/imports"},"summary":"Lists imports","description":"Lists imports — Lists imports.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your parameters. You","security":[{"bearerAuth":[]}]},"post":{"tags":["Imports"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/imports"},"summary":"Import a new file","description":"Import a new file — This function should be used when you need to import a large number of subscribers and adding then individually is very slow. This function expects you to provide import_fields_attributes which is an array indicating what each column in your file represents. If you have the following CSV where the first column is an email, the second is the name of the subscriber and the third is the value for a custom field with id 4: ``` first@example.com,John Doe,my custom value another@ex","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"callback_url":{"type":"string","description":"callback_url (body parameter)"},"existing_subscribers":{"type":"string","description":"existing_subscribers (body parameter)","enum":["ignore","replace","replace_removing_groups"]},"file":{"type":"object","description":"file (body parameter)","required":true},"group_ids":{"type":"array","description":"group_ids (body parameter)","items":{"type":"number"}},"import_fields_attributes":{"type":"array","description":"import_fields_attributes (body parameter)","items":{"type":"object","properties":{"column":{"type":"number","description":"column (body parameter)","required":true},"field":{"type":"string","description":"field (body parameter)","required":true}}}}}},"example":{"callback_url":"callback_url_value","existing_subscribers":"ignore","file":{},"group_ids":[],"import_fields_attributes":[]}}}}}},"/imports/{id}":{"get":{"tags":["Imports"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/imports/{id}"},"summary":"Get a import by id","description":"Get a import by id","security":[{"bearerAuth":[]}]}},"/imports/{id}/cancel":{"patch":{"tags":["Imports"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/imports/{id}/cancel"},"summary":"Cancel a import that is in progress","description":"Cancel a import that is in progress — This will stop and permanently cancel a import. It can't be resumed later.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/imports/{id}/data":{"get":{"tags":["Imports"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/imports/{id}/data"},"summary":"Get line by line data of a import","description":"Get line by line data of a import — Get line by line data of a import.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 10000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total numb","security":[{"bearerAuth":[]}]}},"/media_files":{"get":{"tags":["Media Files"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[media_file_name_cont]","in":"query","description":"Search: Filename contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[media_file_name_eq]","in":"query","description":"Search: Filename equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[media_folder_id_eq]","in":"query","description":"Search: Media folder equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[media_folder_id_gteq]","in":"query","description":"Search: Media folder greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[media_folder_id_lteq]","in":"query","description":"Search: Media folder less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","media_folder_id","media_file_name"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/media_files"},"summary":"Lists media files","description":"Lists media files — Lists media files.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your paramet","security":[{"bearerAuth":[]}]},"post":{"tags":["Media Files"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/media_files"},"summary":"Add a new media file","description":"Add a new media file","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"object","description":"file (body parameter)","required":true},"media_folder_id":{"type":"number","description":"media_folder_id (body parameter)"}}},"example":{"file":{},"media_folder_id":1}}}}}},"/media_files/trashed":{"get":{"tags":["Media Files"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[media_file_name_cont]","in":"query","description":"Search: Filename contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[media_file_name_eq]","in":"query","description":"Search: Filename equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[media_folder_id_eq]","in":"query","description":"Search: Media folder equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[media_folder_id_gteq]","in":"query","description":"Search: Media folder greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[media_folder_id_lteq]","in":"query","description":"Search: Media folder less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","media_folder_id","media_file_name"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/media_files/trashed"},"summary":"List media files in trash","description":"List media files in trash","security":[{"bearerAuth":[]}]}},"/media_files/{id}":{"get":{"tags":["Media Files"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/media_files/{id}"},"summary":"Get a single media file","description":"Get a single media file","security":[{"bearerAuth":[]}]},"delete":{"tags":["Media Files"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/media_files/{id}"},"summary":"Hard delete a media file","description":"Hard delete a media file — This function completely delete the media file. The file URL will no longer work and will affect sent campaigns if it was used","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/media_files/{id}/move_to_trash":{"patch":{"tags":["Media Files"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/media_files/{id}/move_to_trash"},"summary":"Move media file to trash","description":"Move media file to trash — This function delete the media file but keeps the original file URL working","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/media_files/{id}/restore":{"patch":{"tags":["Media Files"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/media_files/{id}/restore"},"summary":"Restore a file that is in trash","description":"Restore a file that is in trash","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/media_folders":{"get":{"tags":["Media Folders"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[name_cont]","in":"query","description":"Search: Name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_eq]","in":"query","description":"Search: Name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","name"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/media_folders"},"summary":"Lists media folders","description":"Lists media folders — Lists media folders.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your par","security":[{"bearerAuth":[]}]},"post":{"tags":["Media Folders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/media_folders"},"summary":"Add a new media folder","description":"Add a new media folder","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"name (body parameter)","required":true}}},"example":{"name":"name_value"}}}}}},"/media_folders/{id}":{"get":{"tags":["Media Folders"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/media_folders/{id}"},"summary":"Get a media folder by id","description":"Get a media folder by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["Media Folders"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/media_folders/{id}"},"summary":"Update a media folder","description":"Update a media folder","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"name (body parameter)"}}},"example":{"name":"name_value"}}}}},"delete":{"tags":["Media Folders"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/media_folders/{id}"},"summary":"Remove a media folder","description":"Remove a media folder","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/rss_campaigns":{"get":{"tags":["RSS Campaigns"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[enabled_not_true]","in":"query","description":"Search: Enabled is false","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[enabled_true]","in":"query","description":"Search: Enabled is true","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","subject","sender_id","segment_id","enabled"]}}},{"name":"q[segment_id_eq]","in":"query","description":"Search: Segment id. This is required if target is set to segment equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[segment_id_gteq]","in":"query","description":"Search: Segment id. This is required if target is set to segment greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[segment_id_lteq]","in":"query","description":"Search: Segment id. This is required if target is set to segment less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[sender_id_eq]","in":"query","description":"Search: Sender equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[sender_id_gteq]","in":"query","description":"Search: Sender greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[sender_id_lteq]","in":"query","description":"Search: Sender less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[subject_cont]","in":"query","description":"Search: Subject contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[subject_eq]","in":"query","description":"Search: Subject equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/rss_campaigns"},"summary":"Lists RSS campaigns","description":"Lists RSS campaigns — Lists RSS campaigns.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 100. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your para","security":[{"bearerAuth":[]}]},"post":{"tags":["RSS Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/rss_campaigns"},"summary":"Add a new RSS campaign","description":"Add a new RSS campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"analytics_utm_campaign":{"type":"string","description":"analytics_utm_campaign (body parameter)"},"editor_type":{"type":"string","description":"editor_type (body parameter)","enum":["html","simple","mr"]},"enabled":{"type":"boolean","description":"enabled (body parameter)","enum":[true,false]},"frequency":{"type":"string","description":"frequency (body parameter)","required":true,"enum":["manual","daily","weekly","monthly"]},"group_ids":{"type":"array","description":"group_ids (body parameter)","items":{"type":"number"}},"hour":{"type":"number","description":"hour (body parameter)"},"html":{"type":"string","description":"html (body parameter)","required":true},"minute":{"type":"number","description":"minute (body parameter)"},"month_days":{"type":"array","description":"month_days (body parameter)","items":{"type":"number"}},"number_of_entries":{"type":"number","description":"number_of_entries (body parameter)","required":true},"preview_text":{"type":"string","description":"preview_text (body parameter)"},"reply_to":{"type":"string","description":"reply_to (body parameter)"},"segment_id":{"type":"number","description":"segment_id (body parameter)"},"sender_id":{"type":"number","description":"sender_id (body parameter)","required":true},"subject":{"type":"string","description":"subject (body parameter)","required":true},"target":{"type":"string","description":"target (body parameter)","required":true,"enum":["groups","segment"]},"track_clicks":{"type":"string","description":"track_clicks (body parameter)"},"track_opens":{"type":"string","description":"track_opens (body parameter)"},"url":{"type":"string","description":"url (body parameter)","required":true},"url_token":{"type":"boolean","description":"url_token (body parameter)","enum":[true,false]},"use_premailer":{"type":"boolean","description":"use_premailer (body parameter)","enum":[true,false]},"week_days":{"type":"array","description":"week_days (body parameter)","items":{"type":"number"}}}},"example":{"analytics_utm_campaign":"analytics_utm_campaign_value","editor_type":"html","enabled":true,"frequency":"manual","group_ids":[],"hour":1,"html":"html_value","minute":1,"month_days":[],"number_of_entries":1,"preview_text":"preview_text_value","reply_to":"reply_to_value","segment_id":1,"sender_id":1,"subject":"subject_value","target":"groups","track_clicks":"track_clicks_value","track_opens":"track_opens_value","url":"url_value","url_token":true,"use_premailer":true,"week_days":[]}}}}}},"/rss_campaigns/{id}":{"get":{"tags":["RSS Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/rss_campaigns/{id}"},"summary":"Get a RSS campaign by id","description":"Get a RSS campaign by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["RSS Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/rss_campaigns/{id}"},"summary":"Update a RSS campaign","description":"Update a RSS campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"analytics_utm_campaign":{"type":"string","description":"analytics_utm_campaign (body parameter)"},"editor_type":{"type":"string","description":"editor_type (body parameter)","enum":["html","simple","mr"]},"enabled":{"type":"boolean","description":"enabled (body parameter)","enum":[true,false]},"frequency":{"type":"string","description":"frequency (body parameter)","enum":["manual","daily","weekly","monthly"]},"group_ids":{"type":"array","description":"group_ids (body parameter)","items":{"type":"number"}},"hour":{"type":"number","description":"hour (body parameter)"},"html":{"type":"string","description":"html (body parameter)"},"minute":{"type":"number","description":"minute (body parameter)"},"month_days":{"type":"array","description":"month_days (body parameter)","items":{"type":"number"}},"number_of_entries":{"type":"number","description":"number_of_entries (body parameter)"},"preview_text":{"type":"string","description":"preview_text (body parameter)"},"reply_to":{"type":"string","description":"reply_to (body parameter)"},"segment_id":{"type":"number","description":"segment_id (body parameter)"},"sender_id":{"type":"number","description":"sender_id (body parameter)"},"subject":{"type":"string","description":"subject (body parameter)"},"target":{"type":"string","description":"target (body parameter)","enum":["groups","segment"]},"track_clicks":{"type":"string","description":"track_clicks (body parameter)"},"track_opens":{"type":"string","description":"track_opens (body parameter)"},"url":{"type":"string","description":"url (body parameter)"},"url_token":{"type":"boolean","description":"url_token (body parameter)","enum":[true,false]},"use_premailer":{"type":"boolean","description":"use_premailer (body parameter)","enum":[true,false]},"week_days":{"type":"array","description":"week_days (body parameter)","items":{"type":"number"}}}},"example":{"analytics_utm_campaign":"analytics_utm_campaign_value","editor_type":"html","enabled":true,"frequency":"manual","group_ids":[],"hour":1,"html":"html_value","minute":1,"month_days":[],"number_of_entries":1,"preview_text":"preview_text_value","reply_to":"reply_to_value","segment_id":1,"sender_id":1,"subject":"subject_value","target":"groups","track_clicks":"track_clicks_value","track_opens":"track_opens_value","url":"url_value","url_token":true,"use_premailer":true,"week_days":[]}}}}},"delete":{"tags":["RSS Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/rss_campaigns/{id}"},"summary":"Remove a RSS campaign","description":"Remove a RSS campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/rss_campaigns/{id}/processed_entries":{"get":{"tags":["RSS Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[entry_id_cont]","in":"query","description":"Search: Entry ID contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[entry_id_eq]","in":"query","description":"Search: Entry ID equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"entry_id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["entry_id","sent_campaign_id"]}}},{"name":"q[sent_campaign_id_eq]","in":"query","description":"Search: Sent campaign equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[sent_campaign_id_gteq]","in":"query","description":"Search: Sent campaign greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[sent_campaign_id_lteq]","in":"query","description":"Search: Sent campaign less than or equal to","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/rss_campaigns/{id}/processed_entries"},"summary":"Get RSS campaign's processed entries","description":"Get RSS campaign's processed entries — Get RSS campaign's processed entries.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total","security":[{"bearerAuth":[]}]}},"/sms/campaigns":{"get":{"tags":["SMS Campaigns"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[created_at_eq]","in":"query","description":"Search: Created at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_gteq]","in":"query","description":"Search: Created at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_lteq]","in":"query","description":"Search: Created at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: Id equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: Id greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: Id less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[message_cont]","in":"query","description":"Search: Message contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[message_eq]","in":"query","description":"Search: Message equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_cont]","in":"query","description":"Search: Name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_eq]","in":"query","description":"Search: Name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","name","sender_name","message","created_at"]}}},{"name":"q[sender_name_cont]","in":"query","description":"Search: Sender name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[sender_name_eq]","in":"query","description":"Search: Sender name equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/campaigns"},"summary":"Lists SMS campaigns","description":"Lists SMS campaigns — Lists SMS campaigns.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 100. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your para","security":[{"bearerAuth":[]}]},"post":{"tags":["SMS Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/campaigns"},"summary":"Add a new SMS campaign","description":"Add a new SMS campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"message (body parameter)","required":true},"name":{"type":"string","description":"name (body parameter)","required":true},"sender_name":{"type":"string","description":"sender_name (body parameter)","required":true},"track_links":{"type":"boolean","description":"track_links (body parameter)","enum":[true,false]}}},"example":{"message":"message_value","name":"name_value","sender_name":"sender_name_value","track_links":true}}}}}},"/sms/campaigns/{id}":{"get":{"tags":["SMS Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/campaigns/{id}"},"summary":"Get SMS campaign by id","description":"Get SMS campaign by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["SMS Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/campaigns/{id}"},"summary":"Update SMS campaign","description":"Update SMS campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"message (body parameter)"},"name":{"type":"string","description":"name (body parameter)"},"sender_name":{"type":"string","description":"sender_name (body parameter)"},"track_links":{"type":"boolean","description":"track_links (body parameter)","enum":[true,false]}}},"example":{"message":"message_value","name":"name_value","sender_name":"sender_name_value","track_links":true}}}}},"delete":{"tags":["SMS Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/campaigns/{id}"},"summary":"Remove SMS campaign","description":"Remove SMS campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/sms/campaigns/{id}/send_all":{"post":{"tags":["SMS Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/campaigns/{id}/send_all"},"summary":"Send SMS campaign","description":"Send SMS campaign — This method is used to send a SMS campaign to groups or a text_list. It will return some attributes, including the ID of the SMS sent campaign which can be used to check the progress and results of the SMS campaign. If you specify a callback URL, we will send a POST request right after the SMS sent campaign is processed. It will contain a JSON with the type of the callback and the ID of the SMS sent campaign. You can use the following command to simulate a callback request: `","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"callback_url":{"type":"string","description":"callback_url (body parameter)"},"group_ids":{"type":"array","description":"group_ids (body parameter)","items":{"type":"number"}},"recipients":{"type":"array","description":"recipients (body parameter)","items":{"type":"string"}},"scheduled_at":{"type":"string","description":"scheduled_at (body parameter)"},"target":{"type":"string","description":"target (body parameter)","required":true,"enum":["groups","text_list"]}}},"example":{"callback_url":"callback_url_value","group_ids":[],"recipients":[],"scheduled_at":"scheduled_at_value","target":"groups"}}}}}},"/sms/sent_campaigns":{"get":{"tags":["SMS Sent Campaigns"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[created_at_eq]","in":"query","description":"Search: Created at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_gteq]","in":"query","description":"Search: Created at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_lteq]","in":"query","description":"Search: Created at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: Id equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: Id greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: Id less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[message_cont]","in":"query","description":"Search: Message contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[message_eq]","in":"query","description":"Search: Message equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_cont]","in":"query","description":"Search: Name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_eq]","in":"query","description":"Search: Name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","name","sender_name","message","status","created_at"]}}},{"name":"q[sender_name_cont]","in":"query","description":"Search: Sender name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[sender_name_eq]","in":"query","description":"Search: Sender name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_cont]","in":"query","description":"Search: Status contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_eq]","in":"query","description":"Search: Status equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/sent_campaigns"},"summary":"Lists SMS sent campaigns","description":"Lists SMS sent campaigns — Lists SMS sent campaigns.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 100. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on","security":[{"bearerAuth":[]}]}},"/sms/sent_campaigns/{id}":{"get":{"tags":["SMS Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/sent_campaigns/{id}"},"summary":"Get a single SMS sent campaign","description":"Get a single SMS sent campaign","security":[{"bearerAuth":[]}]}},"/sms/sent_campaigns/{id}/cancel":{"patch":{"tags":["SMS Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/sent_campaigns/{id}/cancel"},"summary":"Cancel a SMS campaign","description":"Cancel a SMS campaign — This will stop and permanently cancel the campaign. It can't be resumed later.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/sms/sent_campaigns/{id}/pause":{"patch":{"tags":["SMS Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/sent_campaigns/{id}/pause"},"summary":"Pause a SMS campaign that is being processed","description":"Pause a SMS campaign that is being processed","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/sms/sent_campaigns/{id}/resume":{"patch":{"tags":["SMS Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/sent_campaigns/{id}/resume"},"summary":"Resume a SMS campaign that is paused","description":"Resume a SMS campaign that is paused","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/sms/sent_campaigns/{id}/sent_messages":{"get":{"tags":["SMS Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"include_sms_unsubscribe_events","in":"query","description":"Include unsubscribe events in the results","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[delivered_at_eq]","in":"query","description":"Search: Delivered at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[delivered_at_gteq]","in":"query","description":"Search: Delivered at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[delivered_at_lteq]","in":"query","description":"Search: Delivered at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[phone_cont]","in":"query","description":"Search: Phone contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[phone_eq]","in":"query","description":"Search: Phone equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_eq]","in":"query","description":"Search: Processed at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_gteq]","in":"query","description":"Search: Processed at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_lteq]","in":"query","description":"Search: Processed at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"phone desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["phone","status","processed_at","delivered_at"]}}},{"name":"q[status_cont]","in":"query","description":"Search: Status contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_eq]","in":"query","description":"Search: Status equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/sent_campaigns/{id}/sent_messages"},"summary":"Get SMS sent campaign's sent messages","description":"Get SMS sent campaign's sent messages — The default behavior is to only list sent messages without additional information like unsubscribe events. You can optionally use parameters like include_unsubscribe_events to include them but note that it may slow down the response times, so only use them if you need it. If you only need to obtain unsubscribe events, then you should use the methods that only return the data that you need.<br/> #### Pagination This is a paginated resource. You can optional","security":[{"bearerAuth":[]}]}},"/sms/sent_campaigns/{id}/unsubscribe_events":{"get":{"tags":["SMS Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[phone_cont]","in":"query","description":"Search: Phone contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[phone_eq]","in":"query","description":"Search: Phone equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"phone desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["phone","sms_sent_message_id","source"]}}},{"name":"q[sms_sent_message_id_eq]","in":"query","description":"Search: Sms sent message equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[sms_sent_message_id_gteq]","in":"query","description":"Search: Sms sent message greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[sms_sent_message_id_lteq]","in":"query","description":"Search: Sms sent message less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[source_cont]","in":"query","description":"Search: Source contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[source_eq]","in":"query","description":"Search: Source equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/sent_campaigns/{id}/unsubscribe_events"},"summary":"Get SMS sent campaign's unsubscribe events","description":"Get SMS sent campaign's unsubscribe events — Get SMS sent campaign's unsubscribe events.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 10000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Tota","security":[{"bearerAuth":[]}]}},"/sms/sent_messages":{"get":{"tags":["SMS Sent Messages"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[created_at_eq]","in":"query","description":"Search: Created at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_gteq]","in":"query","description":"Search: Created at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_lteq]","in":"query","description":"Search: Created at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: Id equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: Id greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: Id less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[phone_cont]","in":"query","description":"Search: Phone contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[phone_eq]","in":"query","description":"Search: Phone equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_eq]","in":"query","description":"Search: Processed at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_gteq]","in":"query","description":"Search: Processed at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_lteq]","in":"query","description":"Search: Processed at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","phone","status","created_at","processed_at"]}}},{"name":"q[status_cont]","in":"query","description":"Search: Status contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_eq]","in":"query","description":"Search: Status equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/sent_messages"},"summary":"Lists SMS sent messages","description":"Lists SMS sent messages — Lists SMS sent messages.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 100. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on y","security":[{"bearerAuth":[]}]}},"/sms/sent_messages/{id}":{"get":{"tags":["SMS Sent Messages"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/sent_messages/{id}"},"summary":"Get a single SMS sent message","description":"Get a single SMS sent message","security":[{"bearerAuth":[]}]}},"/smtp_emails":{"get":{"tags":["SMTP Emails"],"parameters":[{"name":"include_clicks","in":"query","description":"Include clicks in the results","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"include_impressions","in":"query","description":"Include impressions in the results","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"include_smtp_tags","in":"query","description":"Include smtp tags in the results","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"include_unsubscribe_events","in":"query","description":"Include unsubscribe events in the results","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[email_cont]","in":"query","description":"Search: Email contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[email_eq]","in":"query","description":"Search: Email equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[message_id_cont]","in":"query","description":"Search: Message ID contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[message_id_eq]","in":"query","description":"Search: Message ID equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_eq]","in":"query","description":"Search: Processed at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_gteq]","in":"query","description":"Search: Processed at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_lteq]","in":"query","description":"Search: Processed at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[reported_as_spam_not_true]","in":"query","description":"Search: Reported as spam is false","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[reported_as_spam_true]","in":"query","description":"Search: Reported as spam is true","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"email desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["email","message_id","status","reported_as_spam","processed_at"]}}},{"name":"q[smtp_tag_eq]","in":"query","description":"Search: Smtp tag equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_cont]","in":"query","description":"Search: Status contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_eq]","in":"query","description":"Search: Status equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/smtp_emails"},"summary":"Get SMTP emails","description":"Get SMTP emails — Lists all smtp emails. The default behavior is to only list smtp emails without additional information like clicks, impressions etc. You can optionally use parameters like include_clicks or include_impressions to include them but note that it may slow down the response times, so only use them if you need it.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you ","security":[{"bearerAuth":[]}]}},"/smtp_emails/{id}":{"get":{"tags":["SMTP Emails"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"include_clicks","in":"query","description":"Include clicks in the results","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"include_impressions","in":"query","description":"Include impressions in the results","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"include_smtp_tags","in":"query","description":"Include smtp tags in the results","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"include_unsubscribe_events","in":"query","description":"Include unsubscribe events in the results","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/smtp_emails/{id}"},"summary":"Get an SMTP email by id","description":"Get an SMTP email by id","security":[{"bearerAuth":[]}]}},"/smtp_tags":{"get":{"tags":["SMTP Tags"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"tag desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["tag"]}}},{"name":"q[tag_cont]","in":"query","description":"Search: Tag contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[tag_eq]","in":"query","description":"Search: Tag equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/smtp_tags"},"summary":"Lists SMTP tags","description":"Lists SMTP tags — Lists SMTP tags.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your parameters.","security":[{"bearerAuth":[]}]}},"/send_emails":{"post":{"tags":["Send Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/send_emails"},"summary":"Send email to one or more recipients","description":"Send email to one or more recipients — This method can be used to send an SMTP email from our API to one or more recipients. The response will return an array with the details of each smtp email including the ID, which can be used to verify the status and tracking info later.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"attachments":{"type":"array","description":"attachments (body parameter)","items":{"type":"object","properties":{"content":{"type":"string","description":"content (body parameter)","required":true},"content_id":{"type":"string","description":"content_id (body parameter)"},"content_type":{"type":"string","description":"content_type (body parameter)","required":true},"file_name":{"type":"string","description":"file_name (body parameter)","required":true}}}},"from":{"type":"object","description":"from (body parameter)","required":true},"headers":{"type":"object","description":"headers (body parameter)"},"html_part":{"type":"string","description":"html_part (body parameter)"},"smtp_tags":{"type":"array","description":"smtp_tags (body parameter)","items":{"type":"string"}},"subject":{"type":"string","description":"subject (body parameter)","required":true},"text_part":{"type":"string","description":"text_part (body parameter)"},"text_part_auto":{"type":"boolean","description":"text_part_auto (body parameter)","enum":[true,false]},"to":{"type":"array","description":"to (body parameter)","required":true,"items":{"type":"object","properties":{"email":{"type":"string","description":"email (body parameter)","required":true},"name":{"type":"string","description":"name (body parameter)"}}}}}},"example":{"attachments":[],"from":{},"headers":{},"html_part":"html_part_value","smtp_tags":[],"subject":"subject_value","text_part":"text_part_value","text_part_auto":true,"to":[]}}}}}},"/sms/send":{"post":{"tags":["Send Transactional SMS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sms/send"},"summary":"Send SMS to one or more recipients","description":"Send SMS to one or more recipients — This method can be used to send SMS to one or more recipients. The response will return an array with the details of each SMS including the ID, which can be used to verify the status later.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"message (body parameter)","required":true},"sender_name":{"type":"string","description":"sender_name (body parameter)","required":true},"to":{"type":"array","description":"to (body parameter)","required":true,"items":{"type":"string"}}}},"example":{"message":"message_value","sender_name":"sender_name_value","to":[]}}}}}},"/whatsapp/send":{"post":{"tags":["Send Transactional WhatsApp Messages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/send"},"summary":"Send WhatsApp messages to one or more recipients","description":"Send WhatsApp messages to one or more recipients — Send template-based WhatsApp messages to one or more recipients using approved templates. Template variables must follow these naming conventions: - subscriber_* : Built-in subscriber fields (e.g., subscriber_name, subscriber_email) - custom_* : Arbitrary custom values (e.g., custom_order_id, custom_delivery_date) The response will return an array with the details of each message including the ID, which can be used to verify the status later.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"template_parameters":{"type":"object","description":"template_parameters (body parameter)","required":true},"to":{"type":"array","description":"to (body parameter)","required":true,"items":{"type":"string"}},"whatsapp_phone_number_id":{"type":"number","description":"whatsapp_phone_number_id (body parameter)","required":true},"whatsapp_template_id":{"type":"number","description":"whatsapp_template_id (body parameter)","required":true}}},"example":{"template_parameters":{},"to":[],"whatsapp_phone_number_id":1,"whatsapp_template_id":1}}}}}},"/senders":{"get":{"tags":["Senders"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[confirmed_not_true]","in":"query","description":"Search: Confirmed is false","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[confirmed_true]","in":"query","description":"Search: Confirmed is true","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[default_not_true]","in":"query","description":"Search: Default is false","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[default_true]","in":"query","description":"Search: Default is true","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[email_cont]","in":"query","description":"Search: Email contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[email_eq]","in":"query","description":"Search: Email equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[from_name_cont]","in":"query","description":"Search: From name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[from_name_eq]","in":"query","description":"Search: From name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[name_cont]","in":"query","description":"Search: Name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_eq]","in":"query","description":"Search: Name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","name","from_name","email","confirmed","default"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/senders"},"summary":"Lists senders","description":"Lists senders — Lists senders.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your parameters. You","security":[{"bearerAuth":[]}]},"post":{"tags":["Senders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/senders"},"summary":"Add a new sender","description":"Add a new sender","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"email (body parameter)","required":true},"from_name":{"type":"string","description":"from_name (body parameter)"},"name":{"type":"string","description":"name (body parameter)","required":true}}},"example":{"email":"email_value","from_name":"from_name_value","name":"name_value"}}}}}},"/senders/{id}":{"get":{"tags":["Senders"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/senders/{id}"},"summary":"Get a sender by id","description":"Get a sender by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["Senders"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/senders/{id}"},"summary":"Update a sender","description":"Update a sender","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"default":{"type":"boolean","description":"default (body parameter)","enum":[true,false]},"from_name":{"type":"string","description":"from_name (body parameter)"},"name":{"type":"string","description":"name (body parameter)"}}},"example":{"default":true,"from_name":"from_name_value","name":"name_value"}}}}},"delete":{"tags":["Senders"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/senders/{id}"},"summary":"Remove a sender","description":"Remove a sender — When removing a sender you ***must*** provide the ID of another confirmed sender. This is required because all campaigns and RSS campaigns of the current sender will be moved to another one.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"new_sender_id":{"type":"number","description":"new_sender_id (body parameter)","required":true}}},"example":{"new_sender_id":1}}}}}},"/senders/{id}/send_confirmation_email":{"post":{"tags":["Senders"],"parameters":[{"name":"id","in":"path","description":"ID of a sender that isn't confirmed","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/senders/{id}/send_confirmation_email"},"summary":"Send confirmation email","description":"Send confirmation email — Send confirmation email to a send that isn't confirmed yet.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/sent_campaigns":{"get":{"tags":["Sent Campaigns"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[created_at_eq]","in":"query","description":"Search: Created at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_gteq]","in":"query","description":"Search: Created at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_lteq]","in":"query","description":"Search: Created at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","subject","sender_id","status","created_at"]}}},{"name":"q[sender_id_eq]","in":"query","description":"Search: Sender equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[sender_id_gteq]","in":"query","description":"Search: Sender greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[sender_id_lteq]","in":"query","description":"Search: Sender less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[status_cont]","in":"query","description":"Search: Status contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_eq]","in":"query","description":"Search: Status equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[subject_cont]","in":"query","description":"Search: Subject contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[subject_eq]","in":"query","description":"Search: Subject equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sent_campaigns"},"summary":"Lists sent campaigns","description":"Lists sent campaigns — Lists sent campaigns.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 100. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your pa","security":[{"bearerAuth":[]}]}},"/sent_campaigns/{id}":{"get":{"tags":["Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sent_campaigns/{id}"},"summary":"Get a single sent campaign","description":"Get a single sent campaign","security":[{"bearerAuth":[]}]}},"/sent_campaigns/{id}/cancel":{"patch":{"tags":["Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sent_campaigns/{id}/cancel"},"summary":"Cancel a campaign","description":"Cancel a campaign — This will stop and permanently cancel the campaign. It can't be resumed later.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/sent_campaigns/{id}/clicks":{"get":{"tags":["Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[browser_cont]","in":"query","description":"Search: Browser contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[browser_eq]","in":"query","description":"Search: Browser equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[city_cont]","in":"query","description":"Search: City contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[city_eq]","in":"query","description":"Search: City equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[country_cont]","in":"query","description":"Search: Country contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[country_eq]","in":"query","description":"Search: Country equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[ip_cont]","in":"query","description":"Search: IP contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[ip_eq]","in":"query","description":"Search: IP equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"browser desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["browser","city","state","country","ip"]}}},{"name":"q[state_cont]","in":"query","description":"Search: State contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[state_eq]","in":"query","description":"Search: State equals","required":false,"schema":{"type":"string","example":""}},{"name":"unique","in":"query","description":"Return unique clicks grouped by sent email","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sent_campaigns/{id}/clicks"},"summary":"Get sent campaign's clicks","description":"Get sent campaign's clicks — Get sent campaign's clicks.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 10000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages ba","security":[{"bearerAuth":[]}]}},"/sent_campaigns/{id}/impressions":{"get":{"tags":["Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[browser_cont]","in":"query","description":"Search: Browser contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[browser_eq]","in":"query","description":"Search: Browser equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[city_cont]","in":"query","description":"Search: City contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[city_eq]","in":"query","description":"Search: City equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[country_cont]","in":"query","description":"Search: Country contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[country_eq]","in":"query","description":"Search: Country equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[ip_cont]","in":"query","description":"Search: IP contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[ip_eq]","in":"query","description":"Search: IP equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"browser desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["browser","city","state","country","ip"]}}},{"name":"q[state_cont]","in":"query","description":"Search: State contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[state_eq]","in":"query","description":"Search: State equals","required":false,"schema":{"type":"string","example":""}},{"name":"unique","in":"query","description":"Return unique impressions grouped by sent email","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sent_campaigns/{id}/impressions"},"summary":"Get sent campaign's impressions","description":"Get sent campaign's impressions — Get sent campaign's impressions.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 10000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number o","security":[{"bearerAuth":[]}]}},"/sent_campaigns/{id}/pause":{"patch":{"tags":["Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sent_campaigns/{id}/pause"},"summary":"Pause a campaign that is being sent","description":"Pause a campaign that is being sent","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/sent_campaigns/{id}/resume":{"patch":{"tags":["Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sent_campaigns/{id}/resume"},"summary":"Resume a campaign that is paused","description":"Resume a campaign that is paused","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/sent_campaigns/{id}/sent_emails":{"get":{"tags":["Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"include_clicks","in":"query","description":"Include clicks in the results","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"include_impressions","in":"query","description":"Include impressions in the results","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"include_unsubscribe_events","in":"query","description":"Include unsubscribe events in the results","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[bounce_category_cont]","in":"query","description":"Search: Bounce category contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[bounce_category_eq]","in":"query","description":"Search: Bounce category equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[bounced_at_eq]","in":"query","description":"Search: Bounced at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[bounced_at_gteq]","in":"query","description":"Search: Bounced at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[bounced_at_lteq]","in":"query","description":"Search: Bounced at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[delivered_at_eq]","in":"query","description":"Search: Delivered at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[delivered_at_gteq]","in":"query","description":"Search: Delivered at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[delivered_at_lteq]","in":"query","description":"Search: Delivered at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[email_cont]","in":"query","description":"Search: Email contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[email_eq]","in":"query","description":"Search: Email equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_eq]","in":"query","description":"Search: Processed at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_gteq]","in":"query","description":"Search: Processed at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_lteq]","in":"query","description":"Search: Processed at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"email desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["email","status","processed_at","delivered_at","bounced_at","bounce_category","soft_bounced_at"]}}},{"name":"q[soft_bounced_at_eq]","in":"query","description":"Search: Soft bounced at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[soft_bounced_at_gteq]","in":"query","description":"Search: Soft bounced at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[soft_bounced_at_lteq]","in":"query","description":"Search: Soft bounced at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_cont]","in":"query","description":"Search: Status contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_eq]","in":"query","description":"Search: Status equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sent_campaigns/{id}/sent_emails"},"summary":"Get sent campaign's sent emails","description":"Get sent campaign's sent emails — The default behavior is to only list sent emails without additional information like clicks, impressions or unsubscribe events. You can optionally use parameters like include_clicks or include_impressions to include them but note that it may slow down the response times, so only use them if you need it. If you only need to obtain clicks, impressions or unsubscribe events, then you should use the methods that only return the data that you need.<br/> #### Paginati","security":[{"bearerAuth":[]}]}},"/sent_campaigns/{id}/unsubscribe_events":{"get":{"tags":["Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[email_cont]","in":"query","description":"Search: Email contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[email_eq]","in":"query","description":"Search: Email equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"email desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["email","sent_email_id","source"]}}},{"name":"q[sent_email_id_eq]","in":"query","description":"Search: Sent email equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[sent_email_id_gteq]","in":"query","description":"Search: Sent email greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[sent_email_id_lteq]","in":"query","description":"Search: Sent email less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[source_cont]","in":"query","description":"Search: Source contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[source_eq]","in":"query","description":"Search: Source equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/sent_campaigns/{id}/unsubscribe_events"},"summary":"Get sent campaign's unsubscribe events","description":"Get sent campaign's unsubscribe events — Get sent campaign's unsubscribe events.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 10000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The ","security":[{"bearerAuth":[]}]}},"/signup_forms":{"get":{"tags":["SignupForms"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[name_cont]","in":"query","description":"Search: Name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_eq]","in":"query","description":"Search: Name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","name"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/signup_forms"},"summary":"Lists signup forms","description":"Lists signup forms — Lists signup forms.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your param","security":[{"bearerAuth":[]}]}},"/subscribers":{"get":{"tags":["Subscribers"],"parameters":[{"name":"include_groups","in":"query","description":"Include subscriber's groups in the response.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"include_tags","in":"query","description":"Include subscriber's tags in the response.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[banned]","in":"query","description":"Search subscribers that are banned.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[bounced]","in":"query","description":"Search subscribers that bounced.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[by_status]","in":"query","description":"Search by status. Values can be:\n- <strong>active</strong>: Active subscribers\n- <strong>inactive</strong>: Inactive subscribers\n- <strong>disabled</strong>: Disabled subscribers include those that bounced, reported spam, unsubscribed or are banned.","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_eq]","in":"query","description":"Search: Created at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_gteq]","in":"query","description":"Search: Created at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_lteq]","in":"query","description":"Search: Created at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[email_cont]","in":"query","description":"Search: Email contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[email_eq]","in":"query","description":"Search: Email equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[groups_id_eq_any][]","in":"query","description":"Search subscribers that belongs to any of the selected groups","required":false,"schema":{"type":"array","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[name_cont]","in":"query","description":"Search: Name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_eq]","in":"query","description":"Search: Name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[reported_spam]","in":"query","description":"Search subscribers that reported spam.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","email","sms_phone","whatsapp_phone","name","score","created_at","updated_at"]}}},{"name":"q[score_eq]","in":"query","description":"Search: Score equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[score_gteq]","in":"query","description":"Search: Score greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[score_lteq]","in":"query","description":"Search: Score less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[sms_phone_cont]","in":"query","description":"Search: SMS phone contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[sms_phone_eq]","in":"query","description":"Search: SMS phone equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[tags_name_eq_any][]","in":"query","description":"Search subscribers that have any of the selected tag names","required":false,"schema":{"type":"array","example":""}},{"name":"q[unsubscribed]","in":"query","description":"Search subscribers that unsubscribed.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"q[updated_at_eq]","in":"query","description":"Search: Updated at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_gteq]","in":"query","description":"Search: Updated at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_lteq]","in":"query","description":"Search: Updated at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[whatsapp_phone_cont]","in":"query","description":"Search: WhatsApp phone contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[whatsapp_phone_eq]","in":"query","description":"Search: WhatsApp phone equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers"},"summary":"Get subscribers","description":"Get subscribers — Lists all subscribers.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 10000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your para","security":[{"bearerAuth":[]}]},"post":{"tags":["Subscribers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers"},"summary":"Add a new subscriber","description":"Add a new subscriber — Add a new subscriber Note that you should provide the default subscriber status. - <strong>active</strong>: use this status if the subscriber has already gone through your opt in process and confirmed that he wants to receive your newsletters. - <strong>inactive</strong>: if you use this option, you must use the resend_confirmation_email method to send the confirmation email to the subscriber. Only after clicking at link in the confirmation email, he will be changed to act","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"address":{"type":"string","description":"address (body parameter)"},"birthday":{"type":"string","description":"birthday (body parameter)"},"city":{"type":"string","description":"city (body parameter)"},"country":{"type":"string","description":"country (body parameter)"},"email":{"type":"string","description":"email (body parameter)","required":true},"group_ids":{"type":"array","description":"group_ids (body parameter)","items":{"type":"number"}},"locale":{"type":"string","description":"locale (body parameter)","enum":["en","es","pt-BR","fr","gl","ca","eu","it"]},"name":{"type":"string","description":"name (body parameter)"},"sms_phone":{"type":"string","description":"sms_phone (body parameter)"},"state":{"type":"string","description":"state (body parameter)"},"status":{"type":"string","description":"status (body parameter)","required":true,"enum":["active","inactive"]},"time_zone":{"type":"string","description":"time_zone (body parameter)","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Coyhaique","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Factory","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"]},"website":{"type":"string","description":"website (body parameter)"},"whatsapp_phone":{"type":"string","description":"whatsapp_phone (body parameter)"}}},"example":{"address":"address_value","birthday":"2026-01-01","city":"city_value","country":"country_value","email":"email_value","group_ids":[],"locale":"en","name":"name_value","sms_phone":"sms_phone_value","state":"state_value","status":"active","time_zone":"Africa/Abidjan","website":"website_value","whatsapp_phone":"whatsapp_phone_value"}}}}}},"/subscribers/bulk_update":{"patch":{"tags":["Subscribers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers/bulk_update"},"summary":"Bulk update subscribers","description":"Bulk update subscribers — This method allows bulk updating subscribers. It should be used when you expect to update a large number of subscribers. ### Asynchronous method **Important!** This method is asynchronous, meaning that your request will be processed in a background task. You can specify a callback URL to receive a POST request after the update was processed. Depending on the number of subscribers that will be updated, it can take several minutes. ### Supported actions At this moment, th","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"all_subscribers":{"type":"boolean","description":"all_subscribers (body parameter)","enum":[true,false]},"bulk_action":{"type":"string","description":"bulk_action (body parameter)","required":true,"enum":["remove_from_group"]},"callback_url":{"type":"string","description":"callback_url (body parameter)"},"group_id":{"type":"number","description":"group_id (body parameter)"},"subscriber_ids":{"type":"array","description":"subscriber_ids (body parameter)","items":{"type":"number"}}}},"example":{"all_subscribers":true,"bulk_action":"remove_from_group","callback_url":"callback_url_value","group_id":1,"subscriber_ids":[]}}}}}},"/subscribers/deleted":{"get":{"tags":["Subscribers"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[created_at_eq]","in":"query","description":"Search: Created at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_gteq]","in":"query","description":"Search: Created at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_lteq]","in":"query","description":"Search: Created at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[deleted_at_eq]","in":"query","description":"Search: Deleted at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[deleted_at_gteq]","in":"query","description":"Search: Deleted at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[deleted_at_lteq]","in":"query","description":"Search: Deleted at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[email_cont]","in":"query","description":"Search: Email contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[email_eq]","in":"query","description":"Search: Email equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","email","sms_phone","whatsapp_phone","deleted_at","created_at","updated_at"]}}},{"name":"q[sms_phone_cont]","in":"query","description":"Search: SMS phone contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[sms_phone_eq]","in":"query","description":"Search: SMS phone equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_eq]","in":"query","description":"Search: Updated at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_gteq]","in":"query","description":"Search: Updated at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_lteq]","in":"query","description":"Search: Updated at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[whatsapp_phone_cont]","in":"query","description":"Search: WhatsApp phone contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[whatsapp_phone_eq]","in":"query","description":"Search: WhatsApp phone equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers/deleted"},"summary":"Get deleted subscribers","description":"Get deleted subscribers — Lists deleted subscribers.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 10000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based ","security":[{"bearerAuth":[]}]}},"/subscribers/sync":{"post":{"tags":["Subscribers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers/sync"},"summary":"Create or update a subscriber","description":"Create or update a subscriber — Create or update a subscriber This method can be used when you want to add a subscriber regardless if it already exists. Similar to create action, you should provide a default status which will be used if subscriber doesn't exists. There are two optional parameters that you can provide: - <strong>restore_if_deleted</strong>: set this to true if deleted subscribers should be restored. - <strong>replace_groups</strong>: set this to true if existing groups should be ","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"address":{"type":"string","description":"address (body parameter)"},"birthday":{"type":"string","description":"birthday (body parameter)"},"city":{"type":"string","description":"city (body parameter)"},"country":{"type":"string","description":"country (body parameter)"},"email":{"type":"string","description":"email (body parameter)","required":true},"group_ids":{"type":"array","description":"group_ids (body parameter)","items":{"type":"number"}},"locale":{"type":"string","description":"locale (body parameter)","enum":["en","es","pt-BR","fr","gl","ca","eu","it"]},"name":{"type":"string","description":"name (body parameter)"},"replace_groups":{"type":"boolean","description":"replace_groups (body parameter)","enum":[true,false]},"replace_tags":{"type":"boolean","description":"replace_tags (body parameter)","enum":[true,false]},"restore_if_deleted":{"type":"boolean","description":"restore_if_deleted (body parameter)","enum":[true,false]},"state":{"type":"string","description":"state (body parameter)"},"status":{"type":"string","description":"status (body parameter)","required":true,"enum":["active","inactive"]},"time_zone":{"type":"string","description":"time_zone (body parameter)","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Coyhaique","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Factory","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"]},"website":{"type":"string","description":"website (body parameter)"},"whatsapp_phone":{"type":"string","description":"whatsapp_phone (body parameter)"}}},"example":{"address":"address_value","birthday":"2026-01-01","city":"city_value","country":"country_value","email":"email_value","group_ids":[],"locale":"en","name":"name_value","replace_groups":true,"replace_tags":true,"restore_if_deleted":true,"state":"state_value","status":"active","time_zone":"Africa/Abidjan","website":"website_value","whatsapp_phone":"whatsapp_phone_value"}}}}}},"/subscribers/{id}":{"get":{"tags":["Subscribers"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"include_groups","in":"query","description":"Include subscriber's groups in the response.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"include_tags","in":"query","description":"Include subscriber's tags in the response.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers/{id}"},"summary":"Get a subscriber by id","description":"Get a subscriber by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["Subscribers"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers/{id}"},"summary":"Update a subscriber","description":"Update a subscriber","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"address":{"type":"string","description":"address (body parameter)"},"birthday":{"type":"string","description":"birthday (body parameter)"},"city":{"type":"string","description":"city (body parameter)"},"country":{"type":"string","description":"country (body parameter)"},"group_ids":{"type":"array","description":"group_ids (body parameter)","items":{"type":"number"}},"locale":{"type":"string","description":"locale (body parameter)","enum":["en","es","pt-BR","fr","gl","ca","eu","it"]},"name":{"type":"string","description":"name (body parameter)"},"sms_phone":{"type":"string","description":"sms_phone (body parameter)"},"state":{"type":"string","description":"state (body parameter)"},"time_zone":{"type":"string","description":"time_zone (body parameter)","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Coyhaique","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Factory","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"]},"website":{"type":"string","description":"website (body parameter)"},"whatsapp_phone":{"type":"string","description":"whatsapp_phone (body parameter)"}}},"example":{"address":"address_value","birthday":"2026-01-01","city":"city_value","country":"country_value","group_ids":[],"locale":"en","name":"name_value","sms_phone":"sms_phone_value","state":"state_value","time_zone":"Africa/Abidjan","website":"website_value","whatsapp_phone":"whatsapp_phone_value"}}}}},"delete":{"tags":["Subscribers"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers/{id}"},"summary":"Remove a subscriber","description":"Remove a subscriber — This method can be used to remove a subscriber. The default action to soft delete the subscriber, meaning that you will able to restore it later. In order to comply with GDPR, you can use the permanent_delete parameter which will remove all data from this subscriber.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"permanent_delete":{"type":"boolean","description":"permanent_delete (body parameter)","enum":[true,false]}}},"example":{"permanent_delete":true}}}}}},"/subscribers/{id}/ban":{"patch":{"tags":["Subscribers"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers/{id}/ban"},"summary":"Ban a subscriber","description":"Ban a subscriber","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/subscribers/{id}/resend_confirmation_email":{"post":{"tags":["Subscribers"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers/{id}/resend_confirmation_email"},"summary":"Resend confirmation email to an inactive subscriber","description":"Resend confirmation email to an inactive subscriber","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/subscribers/{id}/restore":{"patch":{"tags":["Subscribers"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers/{id}/restore"},"summary":"Restore a deleted subscriber","description":"Restore a deleted subscriber","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/subscribers/{id}/unban":{"patch":{"tags":["Subscribers"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers/{id}/unban"},"summary":"Unban a subscriber","description":"Unban a subscriber","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/subscribers/{subscriber_id}/tags":{"get":{"tags":["Subscribers"],"parameters":[{"name":"subscriber_id","in":"path","description":"ID of the subscriber","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers/{subscriber_id}/tags"},"summary":"Lists a subscriber's tags","description":"Lists a subscriber's tags — Lists the tags assigned to a subscriber.","security":[{"bearerAuth":[]}]},"post":{"tags":["Subscribers"],"parameters":[{"name":"subscriber_id","in":"path","description":"ID of the subscriber","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers/{subscriber_id}/tags"},"summary":"Add tags to a subscriber","description":"Add tags to a subscriber — Adds the given tags to a subscriber. Already assigned tags are ignored. Tags are matched by name and must already exist.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"tags":{"type":"array","description":"tags (body parameter)","required":true,"items":{"type":"string"}}}},"example":{"tags":[]}}}}},"put":{"tags":["Subscribers"],"parameters":[{"name":"subscriber_id","in":"path","description":"ID of the subscriber","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers/{subscriber_id}/tags"},"summary":"Replace a subscriber's tags","description":"Replace a subscriber's tags — Replaces the subscriber's full tag set with the given tags. An empty array removes all tags. Tags are matched by name and must already exist.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"tags":{"type":"array","description":"tags (body parameter)","required":true,"items":{"type":"string"}}}},"example":{"tags":[]}}}}},"delete":{"tags":["Subscribers"],"parameters":[{"name":"subscriber_id","in":"path","description":"ID of the subscriber","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/subscribers/{subscriber_id}/tags"},"summary":"Remove tags from a subscriber","description":"Remove tags from a subscriber — Removes the given tags from a subscriber. Unknown or unassigned tag names are ignored.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"tags":{"type":"array","description":"tags (body parameter)","required":true,"items":{"type":"string"}}}},"example":{"tags":[]}}}}}},"/tags":{"get":{"tags":["Tags"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: Id equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: Id greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: Id less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[name_cont]","in":"query","description":"Search: Name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_eq]","in":"query","description":"Search: Name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","name"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/tags"},"summary":"Lists tags","description":"Lists tags — Lists tags.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on your parameters. You can u","security":[{"bearerAuth":[]}]},"post":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/tags"},"summary":"Add a new tag","description":"Add a new tag","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"color":{"type":"string","description":"color (body parameter)"},"name":{"type":"string","description":"name (body parameter)","required":true}}},"example":{"color":"color_value","name":"name_value"}}}}}},"/tags/{id}":{"get":{"tags":["Tags"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/tags/{id}"},"summary":"Get a tag by id","description":"Get a tag by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["Tags"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/tags/{id}"},"summary":"Update a tag","description":"Update a tag","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"color":{"type":"string","description":"color (body parameter)"},"name":{"type":"string","description":"name (body parameter)"}}},"example":{"color":"color_value","name":"name_value"}}}}},"delete":{"tags":["Tags"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/tags/{id}"},"summary":"Remove a tag","description":"Remove a tag — Remove a tag. Removing a tag also unassigns it from all subscribers. A tag that is being used by an automation can't be removed.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/unsubscribe_events":{"get":{"tags":["Unsubscribe Events"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[description_cont]","in":"query","description":"Search: Description contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[description_eq]","in":"query","description":"Search: Description equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[ip_cont]","in":"query","description":"Search: IP contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[ip_eq]","in":"query","description":"Search: IP equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[reason_cont]","in":"query","description":"Search: Reason contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[reason_eq]","in":"query","description":"Search: Reason equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","source","sent_email_id","ip","reason","description"]}}},{"name":"q[sent_email_id_eq]","in":"query","description":"Search: Sent email equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[sent_email_id_gteq]","in":"query","description":"Search: Sent email greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[sent_email_id_lteq]","in":"query","description":"Search: Sent email less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[source_cont]","in":"query","description":"Search: Source contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[source_eq]","in":"query","description":"Search: Source equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/unsubscribe_events"},"summary":"Lists unsubscribe events","description":"Lists unsubscribe events — Lists unsubscribe events.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based o","security":[{"bearerAuth":[]}]},"post":{"tags":["Unsubscribe Events"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/unsubscribe_events"},"summary":"Add a new unsubscribe event","description":"Add a new unsubscribe event — Use this method to create an unsubscribe event. The unsubscribe event is always created for a specific sent email id. If the sent email is associated with a subscriber, the subscriber will also be set as unsubscribed.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"description (body parameter)"},"ip":{"type":"string","description":"ip (body parameter)"},"reason":{"type":"string","description":"reason (body parameter)","enum":["no_interest","didnt_sign_up","spam","other"]},"sent_email_id":{"type":"number","description":"sent_email_id (body parameter)","required":true}}},"example":{"description":"description_value","ip":"ip_value","reason":"no_interest","sent_email_id":1}}}}}},"/unsubscribe_events/{id}":{"get":{"tags":["Unsubscribe Events"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/unsubscribe_events/{id}"},"summary":"Get an unsubscribe event by id","description":"Get an unsubscribe event by id","security":[{"bearerAuth":[]}]},"delete":{"tags":["Unsubscribe Events"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/unsubscribe_events/{id}"},"summary":"Remove an unsubscribe event","description":"Remove an unsubscribe event — Remove an unsubscribe event. Please, note that this method will only work if the unsubscribe event was created using the API. Unsubscribe events created elsewhere can't be removed.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/whatsapp/campaigns":{"get":{"tags":["WhatsApp Campaigns"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[created_at_eq]","in":"query","description":"Search: Created at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_gteq]","in":"query","description":"Search: Created at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_lteq]","in":"query","description":"Search: Created at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[last_sent_at_eq]","in":"query","description":"Search: Last sent at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[last_sent_at_gteq]","in":"query","description":"Search: Last sent at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[last_sent_at_lteq]","in":"query","description":"Search: Last sent at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_cont]","in":"query","description":"Search: Name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_eq]","in":"query","description":"Search: Name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","name","last_sent_at","created_at","updated_at"]}}},{"name":"q[updated_at_eq]","in":"query","description":"Search: Updated at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_gteq]","in":"query","description":"Search: Updated at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[updated_at_lteq]","in":"query","description":"Search: Updated at less than or equal to","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/campaigns"},"summary":"Lists WhatsApp campaigns","description":"Lists WhatsApp campaigns — Lists WhatsApp campaigns.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 100. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of pages based on","security":[{"bearerAuth":[]}]},"post":{"tags":["WhatsApp Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/campaigns"},"summary":"Add a new WhatsApp campaign","description":"Add a new WhatsApp campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"group_ids":{"type":"array","description":"group_ids (body parameter)","items":{"type":"number"}},"name":{"type":"string","description":"name (body parameter)","required":true},"segment_id":{"type":"number","description":"segment_id (body parameter)"},"target":{"type":"string","description":"target (body parameter)","required":true,"enum":["groups","segment"]},"whatsapp_phone_number_id":{"type":"number","description":"whatsapp_phone_number_id (body parameter)","required":true},"whatsapp_template_id":{"type":"number","description":"whatsapp_template_id (body parameter)","required":true}}},"example":{"group_ids":[],"name":"name_value","segment_id":1,"target":"groups","whatsapp_phone_number_id":1,"whatsapp_template_id":1}}}}}},"/whatsapp/campaigns/{id}":{"get":{"tags":["WhatsApp Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/campaigns/{id}"},"summary":"Get WhatsApp campaign by id","description":"Get WhatsApp campaign by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["WhatsApp Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/campaigns/{id}"},"summary":"Update WhatsApp campaign","description":"Update WhatsApp campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"group_ids":{"type":"array","description":"group_ids (body parameter)","items":{"type":"number"}},"name":{"type":"string","description":"name (body parameter)"},"segment_id":{"type":"number","description":"segment_id (body parameter)"},"target":{"type":"string","description":"target (body parameter)","enum":["groups","segment"]},"whatsapp_phone_number_id":{"type":"number","description":"whatsapp_phone_number_id (body parameter)"},"whatsapp_template_id":{"type":"number","description":"whatsapp_template_id (body parameter)"}}},"example":{"group_ids":[],"name":"name_value","segment_id":1,"target":"groups","whatsapp_phone_number_id":1,"whatsapp_template_id":1}}}}},"delete":{"tags":["WhatsApp Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/campaigns/{id}"},"summary":"Remove WhatsApp campaign","description":"Remove WhatsApp campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/whatsapp/campaigns/{id}/send_all":{"post":{"tags":["WhatsApp Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/campaigns/{id}/send_all"},"summary":"Send WhatsApp campaign","description":"Send WhatsApp campaign — This method is used to send a WhatsApp campaign to groups or a specific segment. It will return some attributes, including the ID of the WhatsApp sent campaign which can be used to check the progress and results of the WhatsApp campaign. If you specify a callback URL, we will send a POST request right after the WhatsApp sent campaign is processed. It will contain a JSON with the type of the callback and the ID of the WhatsApp sent campaign. You can use the following comm","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"callback_url":{"type":"string","description":"callback_url (body parameter)"},"group_ids":{"type":"array","description":"group_ids (body parameter)","items":{"type":"number"}},"scheduled_at":{"type":"string","description":"scheduled_at (body parameter)"},"segment_id":{"type":"number","description":"segment_id (body parameter)"},"target":{"type":"string","description":"target (body parameter)","required":true,"enum":["groups","segment"]}}},"example":{"callback_url":"callback_url_value","group_ids":[],"scheduled_at":"scheduled_at_value","segment_id":1,"target":"groups"}}}}}},"/whatsapp/phone_numbers":{"get":{"tags":["WhatsApp Phone Numbers"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[phone_number_cont]","in":"query","description":"Search: Phone number contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[phone_number_eq]","in":"query","description":"Search: Phone number equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[phone_verified_name_cont]","in":"query","description":"Search: Phone verified name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[phone_verified_name_eq]","in":"query","description":"Search: Phone verified name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","phone_number","phone_verified_name"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/phone_numbers"},"summary":"Lists WhatsApp phone numbers","description":"Lists WhatsApp phone numbers — Lists all connected WhatsApp phone numbers.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total n","security":[{"bearerAuth":[]}]}},"/whatsapp/phone_numbers/{id}":{"get":{"tags":["WhatsApp Phone Numbers"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/phone_numbers/{id}"},"summary":"Get a WhatsApp phone number by id","description":"Get a WhatsApp phone number by id — Get a specific WhatsApp phone number details","security":[{"bearerAuth":[]}]},"delete":{"tags":["WhatsApp Phone Numbers"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/phone_numbers/{id}"},"summary":"Remove a WhatsApp phone number","description":"Remove a WhatsApp phone number — Remove a WhatsApp phone number connection. Cannot delete if the phone number has active campaigns (pending, processing, or paused).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/whatsapp/sent_campaigns":{"get":{"tags":["WhatsApp Sent Campaigns"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[created_at_eq]","in":"query","description":"Search: Created at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_gteq]","in":"query","description":"Search: Created at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_lteq]","in":"query","description":"Search: Created at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[finished_at_eq]","in":"query","description":"Search: Finished at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[finished_at_gteq]","in":"query","description":"Search: Finished at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[finished_at_lteq]","in":"query","description":"Search: Finished at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","status","created_at","scheduled_at","finished_at","target","whatsapp_campaign_id"]}}},{"name":"q[scheduled_at_eq]","in":"query","description":"Search: Scheduled at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[scheduled_at_gteq]","in":"query","description":"Search: Scheduled at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[scheduled_at_lteq]","in":"query","description":"Search: Scheduled at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_cont]","in":"query","description":"Search: Status contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_eq]","in":"query","description":"Search: Status equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[target_cont]","in":"query","description":"Search: Target contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[target_eq]","in":"query","description":"Search: Target equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[whatsapp_campaign_id_eq]","in":"query","description":"Search: Whatsapp campaign equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[whatsapp_campaign_id_gteq]","in":"query","description":"Search: Whatsapp campaign greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[whatsapp_campaign_id_lteq]","in":"query","description":"Search: Whatsapp campaign less than or equal to","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/sent_campaigns"},"summary":"Lists WhatsApp sent campaigns","description":"Lists WhatsApp sent campaigns — Lists WhatsApp sent campaigns.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 100. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of page","security":[{"bearerAuth":[]}]}},"/whatsapp/sent_campaigns/{id}":{"get":{"tags":["WhatsApp Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/sent_campaigns/{id}"},"summary":"Get a single WhatsApp sent campaign","description":"Get a single WhatsApp sent campaign","security":[{"bearerAuth":[]}]}},"/whatsapp/sent_campaigns/{id}/cancel":{"patch":{"tags":["WhatsApp Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/sent_campaigns/{id}/cancel"},"summary":"Cancel a WhatsApp campaign","description":"Cancel a WhatsApp campaign — This will stop and permanently cancel the campaign. It can't be resumed later.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/whatsapp/sent_campaigns/{id}/pause":{"patch":{"tags":["WhatsApp Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/sent_campaigns/{id}/pause"},"summary":"Pause a WhatsApp campaign that is being sent","description":"Pause a WhatsApp campaign that is being sent","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/whatsapp/sent_campaigns/{id}/resume":{"patch":{"tags":["WhatsApp Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/sent_campaigns/{id}/resume"},"summary":"Resume a WhatsApp campaign that is paused","description":"Resume a WhatsApp campaign that is paused","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/whatsapp/sent_campaigns/{id}/sent_messages":{"get":{"tags":["WhatsApp Sent Campaigns"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[category_cont]","in":"query","description":"Search: Category contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[category_eq]","in":"query","description":"Search: Category equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[country_cont]","in":"query","description":"Search: Country contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[country_eq]","in":"query","description":"Search: Country equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[delivered_at_eq]","in":"query","description":"Search: Delivered at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[delivered_at_gteq]","in":"query","description":"Search: Delivered at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[delivered_at_lteq]","in":"query","description":"Search: Delivered at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[error_code_cont]","in":"query","description":"Search: Error code contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[error_code_eq]","in":"query","description":"Search: Error code equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[failed_at_eq]","in":"query","description":"Search: Failed at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[failed_at_gteq]","in":"query","description":"Search: Failed at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[failed_at_lteq]","in":"query","description":"Search: Failed at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[phone_cont]","in":"query","description":"Search: Phone contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[phone_eq]","in":"query","description":"Search: Phone equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_eq]","in":"query","description":"Search: Processed at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_gteq]","in":"query","description":"Search: Processed at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_lteq]","in":"query","description":"Search: Processed at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"phone desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["phone","status","country","category","processed_at","delivered_at","failed_at","error_code"]}}},{"name":"q[status_cont]","in":"query","description":"Search: Status contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_eq]","in":"query","description":"Search: Status equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/sent_campaigns/{id}/sent_messages"},"summary":"Get WhatsApp sent campaign's sent messages","description":"Get WhatsApp sent campaign's sent messages — Get WhatsApp sent campaign's sent messages.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 10000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Tota","security":[{"bearerAuth":[]}]}},"/whatsapp/sent_messages":{"get":{"tags":["WhatsApp Sent Messages"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[category_cont]","in":"query","description":"Search: Category contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[category_eq]","in":"query","description":"Search: Category equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_eq]","in":"query","description":"Search: Created at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_gteq]","in":"query","description":"Search: Created at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[created_at_lteq]","in":"query","description":"Search: Created at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[delivered_at_eq]","in":"query","description":"Search: Delivered at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[delivered_at_gteq]","in":"query","description":"Search: Delivered at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[delivered_at_lteq]","in":"query","description":"Search: Delivered at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[failed_at_eq]","in":"query","description":"Search: Failed at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[failed_at_gteq]","in":"query","description":"Search: Failed at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[failed_at_lteq]","in":"query","description":"Search: Failed at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[phone_cont]","in":"query","description":"Search: Phone contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[phone_eq]","in":"query","description":"Search: Phone equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_eq]","in":"query","description":"Search: Processed at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_gteq]","in":"query","description":"Search: Processed at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[processed_at_lteq]","in":"query","description":"Search: Processed at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[read_at_eq]","in":"query","description":"Search: Read at equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[read_at_gteq]","in":"query","description":"Search: Read at greater than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[read_at_lteq]","in":"query","description":"Search: Read at less than or equal to","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","phone","status","category","created_at","processed_at","delivered_at","read_at","failed_at"]}}},{"name":"q[status_cont]","in":"query","description":"Search: Status contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_eq]","in":"query","description":"Search: Status equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/sent_messages"},"summary":"Lists WhatsApp sent messages","description":"Lists WhatsApp sent messages — Lists WhatsApp transactional sent messages.<br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 100. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total nu","security":[{"bearerAuth":[]}]}},"/whatsapp/sent_messages/{id}":{"get":{"tags":["WhatsApp Sent Messages"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/sent_messages/{id}"},"summary":"Get a single WhatsApp sent message","description":"Get a single WhatsApp sent message — Get a single WhatsApp transactional sent message","security":[{"bearerAuth":[]}]}},"/whatsapp/templates":{"get":{"tags":["WhatsApp Templates"],"parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of records per page","required":false,"schema":{"type":"number","example":""}},{"name":"q[category_cont]","in":"query","description":"Search: Category contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[category_eq]","in":"query","description":"Search: Category equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[id_eq]","in":"query","description":"Search: ID equals","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_gteq]","in":"query","description":"Search: ID greater than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[id_lteq]","in":"query","description":"Search: ID less than or equal to","required":false,"schema":{"type":"number","example":""}},{"name":"q[language_cont]","in":"query","description":"Search: Language contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[language_eq]","in":"query","description":"Search: Language equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_cont]","in":"query","description":"Search: Name contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[name_eq]","in":"query","description":"Search: Name equals","required":false,"schema":{"type":"string","example":""}},{"name":"q[s]","in":"query","description":"Allows ordering the records based on a specific field. You may optionally append \"asc\" or \"desc\" to define the direction. Example: \"id desc\"","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["id","name","category","status","language"]}}},{"name":"q[status_cont]","in":"query","description":"Search: Status contains","required":false,"schema":{"type":"string","example":""}},{"name":"q[status_eq]","in":"query","description":"Search: Status equals","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/templates"},"summary":"Lists WhatsApp templates","description":"Lists WhatsApp templates — Lists all WhatsApp message templates. <br/> #### Pagination This is a paginated resource. You can optionally send two query parameters: | Parameter | Description | | ------ | ------ | | page | The page that you want to retrieve. It starts with 1. | | per_page | The number of records returned per page. The max allowed value for this resource is 1000. | The response will include two HTTP headers: | Header | Description | | ------ | ------ | | Total | The total number of ","security":[{"bearerAuth":[]}]},"post":{"tags":["WhatsApp Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/templates"},"summary":"Create a new WhatsApp template","description":"Create a new WhatsApp template — Create a new WhatsApp message template in DRAFT status. ## Components Examples ### Basic template: ```json { \"components\": [ { \"type\": \"BODY\", \"text\": \"Hello {{subscriber_name}}, welcome to our service!\", \"example\": { \"body_text_named_params\": [{ \"param_name\": \"subscriber_name\", \"example\": \"John\" }] } } ] } ``` ### Template with text header and footer: ```json { \"components\": [ { \"type\": \"HEADER\", \"format\": \"TEXT\", \"text\": \"Welcome to our service\" }, { \"type\": \"B","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"string","description":"category (body parameter)","required":true,"enum":["AUTHENTICATION","MARKETING","UTILITY"]},"components":{"type":"array","description":"components (body parameter)","required":true,"items":{"type":"object","properties":{"text":{"type":"string","description":"text (body parameter)"},"type":{"type":"string","description":"type (body parameter)","required":true,"enum":["HEADER","BODY","FOOTER","BUTTONS"]},"buttons":{"type":"array","description":"buttons (body parameter)"},"example":{"type":"object","description":"example (body parameter)"},"format":{"type":"string","description":"format (body parameter)","enum":["TEXT","IMAGE","VIDEO","DOCUMENT"]}}}},"header_media":{"type":"object","description":"header_media (body parameter)"},"language":{"type":"string","description":"language (body parameter)","required":true,"enum":["af","sq","ar","ar_EG","ar_AE","ar_LB","ar_MA","ar_QA","az","be_BY","bn","bn_IN","bg","ca","zh_CN","zh_HK","zh_TW","hr","cs","da","prs_AF","nl","nl_BE","en","en_GB","en_US","en_AE","en_AU","en_CA","en_GH","en_IE","en_IN","en_JM","en_MY","en_NZ","en_QA","en_SG","en_UG","en_ZA","et","fil","fi","fr","fr_BE","fr_CA","fr_CH","fr_CI","fr_MA","ka","de","de_AT","de_CH","el","gu","ha","he","hi","hu","id","ga","it","ja","kn","kk","rw_RW","ko","ky_KG","lo","lv","lt","mk","ms","ml","mr","nb","ps_AF","fa","pl","pt_BR","pt_PT","pa","ro","ru","sr","si_LK","sk","sl","es","es_AR","es_CL","es_CO","es_CR","es_DO","es_EC","es_HN","es_MX","es_PA","es_PE","es_ES","es_UY","sw","sv","ta","te","th","tr","uk","ur","uz","vi","zu"]},"name":{"type":"string","description":"name (body parameter)","required":true},"waba_id":{"type":"string","description":"waba_id (body parameter)","required":true}}},"example":{"category":"AUTHENTICATION","components":[],"header_media":{},"language":"af","name":"name_value","waba_id":"waba_id_value"}}}}}},"/whatsapp/templates/{id}":{"get":{"tags":["WhatsApp Templates"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/templates/{id}"},"summary":"Get a WhatsApp template by id","description":"Get a WhatsApp template by id — Get a specific WhatsApp template with full details including components","security":[{"bearerAuth":[]}]},"patch":{"tags":["WhatsApp Templates"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/templates/{id}"},"summary":"Update a WhatsApp template","description":"Update a WhatsApp template — Update a WhatsApp template. Only templates with DRAFT or REJECTED status can be edited. Template name can only be changed for DRAFT templates. ## Components Examples ### Basic template: ```json { \"components\": [ { \"type\": \"BODY\", \"text\": \"Hello {{subscriber_name}}, welcome to our service!\", \"example\": { \"body_text_named_params\": [{ \"param_name\": \"subscriber_name\", \"example\": \"John\" }] } } ] } ``` ### Template with text header and footer: ```json { \"components\": [ { \"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"string","description":"category (body parameter)","enum":["AUTHENTICATION","MARKETING","UTILITY"]},"components":{"type":"array","description":"components (body parameter)","items":{"type":"object","properties":{"text":{"type":"string","description":"text (body parameter)"},"type":{"type":"string","description":"type (body parameter)","required":true,"enum":["HEADER","BODY","FOOTER","BUTTONS"]},"buttons":{"type":"array","description":"buttons (body parameter)"},"example":{"type":"object","description":"example (body parameter)"},"format":{"type":"string","description":"format (body parameter)","enum":["TEXT","IMAGE","VIDEO","DOCUMENT"]}}}},"header_media":{"type":"object","description":"header_media (body parameter)"},"language":{"type":"string","description":"language (body parameter)","enum":["af","sq","ar","ar_EG","ar_AE","ar_LB","ar_MA","ar_QA","az","be_BY","bn","bn_IN","bg","ca","zh_CN","zh_HK","zh_TW","hr","cs","da","prs_AF","nl","nl_BE","en","en_GB","en_US","en_AE","en_AU","en_CA","en_GH","en_IE","en_IN","en_JM","en_MY","en_NZ","en_QA","en_SG","en_UG","en_ZA","et","fil","fi","fr","fr_BE","fr_CA","fr_CH","fr_CI","fr_MA","ka","de","de_AT","de_CH","el","gu","ha","he","hi","hu","id","ga","it","ja","kn","kk","rw_RW","ko","ky_KG","lo","lv","lt","mk","ms","ml","mr","nb","ps_AF","fa","pl","pt_BR","pt_PT","pa","ro","ru","sr","si_LK","sk","sl","es","es_AR","es_CL","es_CO","es_CR","es_DO","es_EC","es_HN","es_MX","es_PA","es_PE","es_ES","es_UY","sw","sv","ta","te","th","tr","uk","ur","uz","vi","zu"]},"waba_id":{"type":"string","description":"waba_id (body parameter)"}}},"example":{"category":"AUTHENTICATION","components":[],"header_media":{},"language":"af","waba_id":"waba_id_value"}}}}},"delete":{"tags":["WhatsApp Templates"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/templates/{id}"},"summary":"Delete a WhatsApp template","description":"Delete a WhatsApp template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/whatsapp/templates/{id}/submit_for_approval":{"post":{"tags":["WhatsApp Templates"],"parameters":[{"name":"id","in":"path","description":"ID of the record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidocs.mailrelay.com/","api_endpoint":"https://{account}/api/v1/whatsapp/templates/{id}/submit_for_approval"},"summary":"Submit template for approval","description":"Submit template for approval — Submit a WhatsApp template for WhatsApp's approval. Only DRAFT templates that have components can be submitted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}