Skip to content

Commit 446aeed

Browse files
author
github-actions
committed
Update REST API documentation Thu Apr 2 07:50:55 UTC 2026
1 parent 50cff12 commit 446aeed

1 file changed

Lines changed: 265 additions & 115 deletions

File tree

‎restapi.json‎

Lines changed: 265 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -1590,6 +1590,271 @@
15901590
}
15911591
}
15921592
},
1593+
"/api/v2/campaigns/{messageId}/copy": {
1594+
"post": {
1595+
"tags": [
1596+
"campaigns"
1597+
],
1598+
"summary": "Copies campaign/message by id.",
1599+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Copies campaign/message by id into a draft message.",
1600+
"operationId": "858216f8617f37fd5f4d40d4f84632d0",
1601+
"parameters": [
1602+
{
1603+
"name": "php-auth-pw",
1604+
"in": "header",
1605+
"description": "Session key obtained from login",
1606+
"required": true,
1607+
"schema": {
1608+
"type": "string"
1609+
}
1610+
},
1611+
{
1612+
"name": "messageId",
1613+
"in": "path",
1614+
"description": "message ID",
1615+
"required": true,
1616+
"schema": {
1617+
"type": "string"
1618+
}
1619+
}
1620+
],
1621+
"responses": {
1622+
"201": {
1623+
"description": "Success",
1624+
"content": {
1625+
"application/json": {
1626+
"schema": {
1627+
"$ref": "#/components/schemas/Message"
1628+
}
1629+
}
1630+
}
1631+
},
1632+
"403": {
1633+
"description": "Failure",
1634+
"content": {
1635+
"application/json": {
1636+
"schema": {
1637+
"$ref": "#/components/schemas/UnauthorizedResponse"
1638+
}
1639+
}
1640+
}
1641+
}
1642+
}
1643+
}
1644+
},
1645+
"/api/v2/campaigns/{messageId}/status": {
1646+
"patch": {
1647+
"tags": [
1648+
"campaigns"
1649+
],
1650+
"summary": "Update campaign status by id.",
1651+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Updates campaign/message status by id.",
1652+
"operationId": "8b4d780c2f00df2eddca6244cbfc45d8",
1653+
"parameters": [
1654+
{
1655+
"name": "php-auth-pw",
1656+
"in": "header",
1657+
"description": "Session key obtained from login",
1658+
"required": true,
1659+
"schema": {
1660+
"type": "string"
1661+
}
1662+
},
1663+
{
1664+
"name": "messageId",
1665+
"in": "path",
1666+
"description": "message ID",
1667+
"required": true,
1668+
"schema": {
1669+
"type": "string"
1670+
}
1671+
}
1672+
],
1673+
"requestBody": {
1674+
"description": "Update message status.",
1675+
"required": true,
1676+
"content": {
1677+
"application/json": {
1678+
"schema": {
1679+
"required": [
1680+
"status"
1681+
],
1682+
"properties": {
1683+
"status": {
1684+
"type": "string",
1685+
"enum": [
1686+
"draft",
1687+
"scheduled",
1688+
"sent",
1689+
"canceled"
1690+
],
1691+
"example": "draft"
1692+
}
1693+
},
1694+
"type": "object"
1695+
}
1696+
}
1697+
}
1698+
},
1699+
"responses": {
1700+
"200": {
1701+
"description": "Success",
1702+
"content": {
1703+
"application/json": {
1704+
"schema": {
1705+
"$ref": "#/components/schemas/Message"
1706+
}
1707+
}
1708+
}
1709+
},
1710+
"403": {
1711+
"description": "Failure",
1712+
"content": {
1713+
"application/json": {
1714+
"schema": {
1715+
"$ref": "#/components/schemas/UnauthorizedResponse"
1716+
}
1717+
}
1718+
}
1719+
},
1720+
"404": {
1721+
"description": "Failure",
1722+
"content": {
1723+
"application/json": {
1724+
"schema": {
1725+
"$ref": "#/components/schemas/NotFoundErrorResponse"
1726+
}
1727+
}
1728+
}
1729+
},
1730+
"422": {
1731+
"description": "Failure",
1732+
"content": {
1733+
"application/json": {
1734+
"schema": {
1735+
"$ref": "#/components/schemas/ValidationErrorResponse"
1736+
}
1737+
}
1738+
}
1739+
}
1740+
}
1741+
}
1742+
},
1743+
"/api/v2/campaigns/{messageId}/send": {
1744+
"post": {
1745+
"tags": [
1746+
"campaigns"
1747+
],
1748+
"summary": "Processes/sends campaign/message by id.",
1749+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Processes/sends campaign/message by id.",
1750+
"operationId": "8f1cd9b2882cd23e38fb481096e95658",
1751+
"parameters": [
1752+
{
1753+
"name": "php-auth-pw",
1754+
"in": "header",
1755+
"description": "Session key obtained from login",
1756+
"required": true,
1757+
"schema": {
1758+
"type": "string"
1759+
}
1760+
},
1761+
{
1762+
"name": "messageId",
1763+
"in": "path",
1764+
"description": "message ID",
1765+
"required": true,
1766+
"schema": {
1767+
"type": "string"
1768+
}
1769+
}
1770+
],
1771+
"responses": {
1772+
"200": {
1773+
"description": "Success",
1774+
"content": {
1775+
"application/json": {
1776+
"schema": {
1777+
"$ref": "#/components/schemas/Message"
1778+
}
1779+
}
1780+
}
1781+
},
1782+
"403": {
1783+
"description": "Failure",
1784+
"content": {
1785+
"application/json": {
1786+
"schema": {
1787+
"$ref": "#/components/schemas/UnauthorizedResponse"
1788+
}
1789+
}
1790+
}
1791+
}
1792+
}
1793+
}
1794+
},
1795+
"/api/v2/campaigns/{messageId}/resend": {
1796+
"post": {
1797+
"tags": [
1798+
"campaigns"
1799+
],
1800+
"summary": "Processes/sends campaign/message by id to lists.",
1801+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Processes/sends campaign/message by id to specified mailing lists.",
1802+
"operationId": "e83ae5f0557b149d31889770ae75b36b",
1803+
"parameters": [
1804+
{
1805+
"name": "php-auth-pw",
1806+
"in": "header",
1807+
"description": "Session key obtained from login",
1808+
"required": true,
1809+
"schema": {
1810+
"type": "string"
1811+
}
1812+
},
1813+
{
1814+
"name": "messageId",
1815+
"in": "path",
1816+
"description": "message ID",
1817+
"required": true,
1818+
"schema": {
1819+
"type": "string"
1820+
}
1821+
}
1822+
],
1823+
"requestBody": {
1824+
"description": "List ids to send this campaign to.",
1825+
"required": true,
1826+
"content": {
1827+
"application/json": {
1828+
"schema": {
1829+
"$ref": "#/components/schemas/AdminAttributeDefinitionRequest"
1830+
}
1831+
}
1832+
}
1833+
},
1834+
"responses": {
1835+
"200": {
1836+
"description": "Success",
1837+
"content": {
1838+
"application/json": {
1839+
"schema": {
1840+
"$ref": "#/components/schemas/Message"
1841+
}
1842+
}
1843+
}
1844+
},
1845+
"403": {
1846+
"description": "Failure",
1847+
"content": {
1848+
"application/json": {
1849+
"schema": {
1850+
"$ref": "#/components/schemas/UnauthorizedResponse"
1851+
}
1852+
}
1853+
}
1854+
}
1855+
}
1856+
}
1857+
},
15931858
"/api/v2/campaigns": {
15941859
"get": {
15951860
"tags": [
@@ -1984,121 +2249,6 @@
19842249
}
19852250
}
19862251
},
1987-
"/api/v2/campaigns/{messageId}/send": {
1988-
"post": {
1989-
"tags": [
1990-
"campaigns"
1991-
],
1992-
"summary": "Processes/sends campaign/message by id.",
1993-
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Processes/sends campaign/message by id.",
1994-
"operationId": "98fb211884bfcd9bf9206cd4d683532f",
1995-
"parameters": [
1996-
{
1997-
"name": "php-auth-pw",
1998-
"in": "header",
1999-
"description": "Session key obtained from login",
2000-
"required": true,
2001-
"schema": {
2002-
"type": "string"
2003-
}
2004-
},
2005-
{
2006-
"name": "messageId",
2007-
"in": "path",
2008-
"description": "message ID",
2009-
"required": true,
2010-
"schema": {
2011-
"type": "string"
2012-
}
2013-
}
2014-
],
2015-
"responses": {
2016-
"200": {
2017-
"description": "Success",
2018-
"content": {
2019-
"application/json": {
2020-
"schema": {
2021-
"$ref": "#/components/schemas/Message"
2022-
}
2023-
}
2024-
}
2025-
},
2026-
"403": {
2027-
"description": "Failure",
2028-
"content": {
2029-
"application/json": {
2030-
"schema": {
2031-
"$ref": "#/components/schemas/UnauthorizedResponse"
2032-
}
2033-
}
2034-
}
2035-
}
2036-
}
2037-
}
2038-
},
2039-
"/api/v2/campaigns/{messageId}/resend": {
2040-
"post": {
2041-
"tags": [
2042-
"campaigns"
2043-
],
2044-
"summary": "Processes/sends campaign/message by id to lists.",
2045-
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Processes/sends campaign/message by id to specified mailing lists.",
2046-
"operationId": "69aca3faa51e5a7b56745d35605e5563",
2047-
"parameters": [
2048-
{
2049-
"name": "php-auth-pw",
2050-
"in": "header",
2051-
"description": "Session key obtained from login",
2052-
"required": true,
2053-
"schema": {
2054-
"type": "string"
2055-
}
2056-
},
2057-
{
2058-
"name": "messageId",
2059-
"in": "path",
2060-
"description": "message ID",
2061-
"required": true,
2062-
"schema": {
2063-
"type": "string"
2064-
}
2065-
}
2066-
],
2067-
"requestBody": {
2068-
"description": "List ids to send this campaign to.",
2069-
"required": true,
2070-
"content": {
2071-
"application/json": {
2072-
"schema": {
2073-
"$ref": "#/components/schemas/AdminAttributeDefinitionRequest"
2074-
}
2075-
}
2076-
}
2077-
},
2078-
"responses": {
2079-
"200": {
2080-
"description": "Success",
2081-
"content": {
2082-
"application/json": {
2083-
"schema": {
2084-
"$ref": "#/components/schemas/Message"
2085-
}
2086-
}
2087-
}
2088-
},
2089-
"403": {
2090-
"description": "Failure",
2091-
"content": {
2092-
"application/json": {
2093-
"schema": {
2094-
"$ref": "#/components/schemas/UnauthorizedResponse"
2095-
}
2096-
}
2097-
}
2098-
}
2099-
}
2100-
}
2101-
},
21022252
"/api/v2/email-forward/{messageId}": {
21032253
"post": {
21042254
"tags": [

0 commit comments

Comments
 (0)