{ "openapi": "3.1.2", "info": { "title": "Goolara Symphonie REST API", "version": "1.0", "x-symphonie-product-version": "4.8", "description": "Version 1 of the OpenAPI contract for the Symphonie REST API, as implemented by Symphonie 4.8. Public routes, request parameters, JSON request bodies, and response structures are traced to the Release4.8 controllers, WCF contract, ServiceLibrary RestApi implementation, and delegated backend methods. GET, PUT, and DELETE operations accept the password in the Password header (preferred) or password query parameter. POST operations carry accountName, login, password, and apiVersion in their JSON request bodies. This legacy API normally returns HTTP 200 for backend validation, permission, and processing errors; those messages may be unquoted text even when the Content-Type is application/json." }, "servers": [ { "url": "https://{host}", "description": "Your hosted or on-premises Symphonie API server.", "variables": { "host": { "default": "example.com", "description": "Replace with the host name of your Symphonie installation." } } } ], "tags": [ { "name": "Complaints" }, { "name": "Confirmations" }, { "name": "ContentBlocks" }, { "name": "Demographics" }, { "name": "Documents" }, { "name": "GlobalUnsubscribes" }, { "name": "HeldRecipients" }, { "name": "Mailings" }, { "name": "OfflineEvents" }, { "name": "Recipients" }, { "name": "Referral" }, { "name": "Segments" }, { "name": "Subscriptions" }, { "name": "Suppression" }, { "name": "Topics" }, { "name": "Utility" }, { "name": "Workflows" } ], "paths": { "/api/Rest/Complaints": { "get": { "tags": [ "Complaints" ], "summary": "Get complaints", "operationId": "Complaints_Get_Get", "description": "When configured properly, Symphonie will receive a \"complaint\" from the Internet Service Providers (ISPs) that indicates the recipient hit the \"This is spam\" or similar worded item. You can use this API call to determine if a specific email address has complained, or to find all email addresses that complained in a time period. Recipients who complain are automatically put on the global unsubscribe list to prevent them from receiving any further email.", "x-documentation-page": "Complaints", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." }, { "name": "emailAddress", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "endTime", "in": "query", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" } } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful ReportData response, or a legacy status/error message. userData columns: emailAddress, asOf.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReportData" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Confirmations": { "get": { "tags": [ "Confirmations" ], "summary": "Get confirmations", "operationId": "Confirmations_Get_Get", "description": "When utilizing the double-opt-in feature of Symphonie, a recipient can be in one of three status:", "x-documentation-page": "Confirmations-GetData", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful ConfirmationStatus response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ConfirmationStatus" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "delete": { "tags": [ "Confirmations" ], "summary": "Delete confirmations", "operationId": "Confirmations_Delete_Delete", "description": "Remove a confirmation request, making the recipient eligible to be sent emails.", "x-documentation-page": "Confirmations-Delete", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Confirmations/Send": { "put": { "tags": [ "Confirmations" ], "summary": "Send confirmations", "operationId": "Confirmations_Send_Put", "description": "Send a confirmation document to a specific recipient. This implements the double-opt-in logic. Recipients in the confirmation status will not be sent additional emails until they confirm their interest. The Document name provided must exist in the system and be of type 'Confirm'. Only existing recipients can be sent a double-opt-in message — create the recipient before calling this routine.", "x-documentation-page": "Confirmations-SendOne", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "documentName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "post": { "tags": [ "Confirmations" ], "summary": "Send confirmations", "operationId": "Confirmations_Send_Post", "description": "Send a confirmation document to many recipients. This implements the double-opt-in logic. Recipients in the confirmation status will not be sent additional emails until they confirm their interest. The Document name provided must exist in the system and be of type 'Confirm'. Only existing recipients can be sent a double-opt-in message — create the recipient before calling this routine.", "x-documentation-page": "Confirmations-SendMany", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Confirmations_SendMultipleConfirmationsArgs" } } } }, "responses": { "200": { "description": "Successful ConfirmationBatchResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ConfirmationBatchResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Confirmations/Accept": { "put": { "tags": [ "Confirmations" ], "summary": "Accept confirmations", "operationId": "Confirmations_Accept_Put", "description": "Accept the confirmation request for a recipient. Allows you to process the acceptance yourself.", "x-documentation-page": "Confirmations-Accept", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/ContentBlocks": { "get": { "tags": [ "ContentBlocks" ], "summary": "Get content blocks", "operationId": "ContentBlocks_Get_Get", "description": "Get all the fields for a single content block.", "x-documentation-page": "ContentBlocks-Retrieve", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful ContentBlock response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ContentBlock" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "post": { "tags": [ "ContentBlocks" ], "summary": "Post content blocks", "operationId": "ContentBlocks_Post_Post", "description": "Create a new content block or edit an existing one. Content blocks are designed to store content that can be plugged into other content in a Mailing or Document dynamically. It should be content you expect to reuse, such as a sales person's signature line or the contact information for a retail location. Use a Mailing for content that will be sent one time. Every Content Block has a language associated with it. You can create the same content, with the same name, in different languages. Then when a Mailing or Document needs to insert content, the one with the matching language will be selected. The mail merge logic will merge either the text or HTML sections of the Content Block into the Mailing or Document based on where the mail merge tag is found. For example, a mail merge tag in the HTML section will substitute the HTML section from the Content Block.", "x-documentation-page": "ContentBlocks-CreateEdit", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentBlocks_CreateContentBlockArgs" } } } }, "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "delete": { "tags": [ "ContentBlocks" ], "summary": "Delete content blocks", "operationId": "ContentBlocks_Delete_Delete", "description": "Remove an existing content block. Be careful removing Content Blocks that could be used in existing Mailings or Documents, as the removal will break mail merging if the Content Block cannot be found.", "x-documentation-page": "ContentBlocks-Delete", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "contentBlockName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Demographics": { "get": { "tags": [ "Demographics" ], "summary": "Retrieve demographics", "operationId": "Demographics_Retrieve_Get", "description": "Get data about all the demographics.", "x-documentation-page": "Demographics-Retrieve", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful DemographicDefinitionList response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/DemographicDefinitionList" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "post": { "tags": [ "Demographics" ], "summary": "Add demographics", "operationId": "Demographics_Add_Post", "description": "Add a new demographic. If you are using a foreign member table, the column must already exist in your SQL view.", "x-documentation-page": "Demographics-Add", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Demographics_CreateArgs" } } } }, "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "delete": { "tags": [ "Demographics" ], "summary": "Delete demographics", "operationId": "Demographics_Delete_Delete", "description": "Remove a demographic. Be careful about removing demographics that are being used for mail merging, as it will prevent mail merging from working properly.", "x-documentation-page": "Demographics-Delete", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "columnName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Documents/Retrieve": { "get": { "tags": [ "Documents" ], "summary": "Retrieve documents", "operationId": "Documents_Retrieve_Get", "description": "Get data about one specific document.", "x-documentation-page": "Documents-RetrieveOne", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "documentName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful DocumentDetails response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/DocumentDetails" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "post": { "tags": [ "Documents" ], "summary": "Retrieve documents", "operationId": "Documents_Retrieve_Post", "description": "Get data about matching documents.", "x-documentation-page": "Documents-RetrieveMany", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_GetDocumentArguments" } } } }, "responses": { "200": { "description": "Successful ReportData response, or a legacy status/error message. userData columns: Document ID, Document Name, Subject, Unsubscribe Topic.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReportData" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Documents/Create": { "post": { "tags": [ "Documents" ], "summary": "Create documents", "operationId": "Documents_Create_Post", "description": "Create a document. Documents are used for content that should be sent to a specific recipient based on some event. Some example might include an initial welcome message when subscribing, an order or shipping confirmation, or any documents sent by a workflow process.", "x-documentation-page": "Documents-Create", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_CreateDocumentArguments" } } } }, "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Documents/Remove": { "delete": { "tags": [ "Documents" ], "summary": "Delete documents", "operationId": "Documents_Delete_Delete", "description": "Remove an unused document.", "x-documentation-page": "Documents-Delete", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "documentName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Documents/Edit": { "post": { "tags": [ "Documents" ], "summary": "Edit documents", "operationId": "Documents_Edit_Post", "description": "Edit a document. Only the fields that have data are updated. To overwrite an existing field and replace it with no data, or to rename the document, use the web interface.", "x-documentation-page": "Documents-Edit", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_EditDocumentArguments" } } } }, "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Documents/Preview": { "post": { "tags": [ "Documents" ], "summary": "Preview documents", "operationId": "Documents_Preview_Post", "description": "Perform mail merging on a document and return the modified content.", "x-documentation-page": "Documents-PreviewComplex", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_PreviewArguments" } } } }, "responses": { "200": { "description": "Successful PreviewDocument response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PreviewDocument" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "get": { "tags": [ "Documents" ], "summary": "Preview documents", "operationId": "Documents_Preview_Get", "description": "Perform mail merging on a document and return the modified content. This version takes just a few arguments. To provide DynamicTags use the POST version.", "x-documentation-page": "Documents-PreviewSimple", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "documentName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful PreviewDocument response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PreviewDocument" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Documents/Queue": { "post": { "tags": [ "Documents" ], "summary": "Queue documents", "operationId": "Documents_Queue_Post", "description": "Send a document to a recipient. The recipient must have been added to the database previously.", "x-documentation-page": "Documents-QueueComplex", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_QueueArguments" } } } }, "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "put": { "tags": [ "Documents" ], "summary": "Queue documents", "operationId": "Documents_Queue_Put", "description": "Send a document to a recipient. The recipient must have been added to the database previously.", "x-documentation-page": "Documents-QueueSimple", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "documentName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Documents/TestSend": { "post": { "tags": [ "Documents" ], "summary": "Test send documents", "operationId": "Documents_TestSend_Post", "description": "Perform mail merging on a document and send it to the specified email address.", "x-documentation-page": "Documents-TestSendComplex", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_TestSendArguments" } } } }, "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "put": { "tags": [ "Documents" ], "summary": "Test send documents", "operationId": "Documents_TestSend_Put", "description": "Perform mail merging on a document and send it to the specified email address. This version takes just a few arguments. To provide DynamicTags use the POST version.", "x-documentation-page": "Documents-TestSendSimple", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "documentName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Documents/Report": { "post": { "tags": [ "Documents" ], "summary": "Report documents", "operationId": "Documents_Report_Post", "description": "Report on data about opens, clicks, or deliverability for documents with optional arguments to select the documents to query, the time period, or restrict by Report Category, IP address, or a demographic column.", "x-documentation-page": "Documents-Report", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documents_ReportArguments" } } } }, "responses": { "200": { "description": "Successful ReportData response, or a legacy status/error message. userData columns depend on reportType (Clicks, Opens, or Deliverability).", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReportData" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Documents/Complaints": { "get": { "tags": [ "Documents" ], "summary": "Complaints documents", "operationId": "Documents_Complaints_Get", "description": "List the email addresses that have complained to their ISP about your mail.", "x-documentation-page": "Documents-Complaints", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "documentName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "endTime", "in": "query", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful ReportData response, or a legacy status/error message. userData columns: emailAddress.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReportData" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/GlobalUnsubscribes/Retrieve": { "get": { "tags": [ "GlobalUnsubscribes" ], "summary": "Retrieve global unsubscribes", "operationId": "GlobalUnsubscribes_Retrieve_Get", "description": "Export the recipients on the global unsubscribe list.", "x-documentation-page": "GlobalUnsubscribes-Retrieve", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful ReportData response, or a legacy status/error message. userData columns: Email address, Request date.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReportData" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/GlobalUnsubscribes/Check": { "get": { "tags": [ "GlobalUnsubscribes" ], "summary": "Get global unsubscribes", "operationId": "GlobalUnsubscribes_Get_Get", "description": "Determine if a specific email address is on the global unsubscribe list.", "x-documentation-page": "GlobalUnsubscribes-Check", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful SuppressionCount response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SuppressionCount" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/GlobalUnsubscribes/Add": { "post": { "tags": [ "GlobalUnsubscribes" ], "summary": "Add global unsubscribes", "operationId": "GlobalUnsubscribes_Add_Post", "description": "Add multiple email addresses to the global unsubscribe list.", "x-documentation-page": "GlobalUnsubscribes-AddMany", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalUnsubscribes_GlobalUnsubscribesEmails" } } } }, "responses": { "200": { "description": "Successful GlobalUnsubscribeBatchAddResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/GlobalUnsubscribeBatchAddResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "put": { "tags": [ "GlobalUnsubscribes" ], "summary": "Add global unsubscribes", "operationId": "GlobalUnsubscribes_Add_Put", "description": "Add a single email address to the global unsubscribe list.", "x-documentation-page": "GlobalUnsubscribes-AddOne", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/GlobalUnsubscribes/Remove": { "post": { "tags": [ "GlobalUnsubscribes" ], "summary": "Remove global unsubscribes", "operationId": "GlobalUnsubscribes_Remove_Post", "description": "Remove multiple email addresses from the global unsubscribe list.", "x-documentation-page": "GlobalUnsubscribes-RemoveMany", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalUnsubscribes_GlobalUnsubscribesEmails" } } } }, "responses": { "200": { "description": "Successful GlobalUnsubscribeBatchRemoveResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/GlobalUnsubscribeBatchRemoveResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "delete": { "tags": [ "GlobalUnsubscribes" ], "summary": "Remove global unsubscribes", "operationId": "GlobalUnsubscribes_Remove_Delete", "description": "Remove a single email address from the global unsubscribe list.", "x-documentation-page": "GlobalUnsubscribes-RemoveOne", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/HeldRecipients": { "get": { "tags": [ "HeldRecipients" ], "summary": "Retrieve held recipients", "operationId": "HeldRecipients_Retrieve_Get", "description": "Return information about recipients who are held, meaning their email address was reported as invalid by a mail server. Get the status for a single recipients, or all recipients in a time period.", "x-documentation-page": "Held-Retrieve", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." }, { "name": "emailAddress", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" } } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful ReportData response, or a legacy status/error message. userData columns: emailAddress, asOf.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReportData" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "post": { "tags": [ "HeldRecipients" ], "summary": "Add held recipients", "operationId": "HeldRecipients_Add_Post", "description": "Add recipients marked as held - meaning their email address is invalid. The recipient must already be created in the system.", "x-documentation-page": "Held-Add", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeldRecipients_AddHeldRecipients" } } } }, "responses": { "200": { "description": "Successful HeldRecipientsBatchResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/HeldRecipientsBatchResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "delete": { "tags": [ "HeldRecipients" ], "summary": "Remove held recipients", "operationId": "HeldRecipients_Remove_Delete", "description": "Remove recipients from the held list.", "x-documentation-page": "Held-Remove", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Mailings/Retrieve": { "get": { "tags": [ "Mailings" ], "summary": "Retrieve mailings", "operationId": "Mailings_Retrieve_Get", "description": "Get information about a specific mailing.", "x-documentation-page": "Mailings-RetrieveOne", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "title", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful MailingDetails response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MailingDetails" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "post": { "tags": [ "Mailings" ], "summary": "Retrieve mailings", "operationId": "Mailings_Retrieve_Post", "description": "Get a few key pieces of information about a range of mailings.", "x-documentation-page": "Mailings-RetrieveMany", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mailings_GetMailingArguments" } } } }, "responses": { "200": { "description": "Successful ReportData response, or a legacy status/error message. userData columns: Mailing ID, Mailing Title, Subject, Topic.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReportData" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Mailings/Create": { "post": { "tags": [ "Mailings" ], "summary": "Create mailings", "operationId": "Mailings_Create_Post", "description": "Create a new mailing.", "x-documentation-page": "Mailings-Create", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mailings_CreateMailingArguments" } } } }, "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Mailings/Remove": { "delete": { "tags": [ "Mailings" ], "summary": "Remove mailings", "operationId": "Mailings_Remove_Delete", "description": "Remove an unsent mailing.", "x-documentation-page": "Mailings-Remove", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "mailingTitle", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Mailings/Audience": { "get": { "tags": [ "Mailings" ], "summary": "Audience mailings", "operationId": "Mailings_Audience_Get", "description": "Gets the list of recipients for an unsent mailing where the audience has been provided as a specific set of recipients. No results are shown if the audience is a segment or all subscribed recipients of a topic. To view the recipients queued for a mailing use the Report API.", "x-documentation-page": "Mailings-AudienceGet", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "mailingTitle", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful ReportData response, or a legacy status/error message. userData columns: emailAddress.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReportData" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "post": { "tags": [ "Mailings" ], "summary": "Audience mailings", "operationId": "Mailings_Audience_Post", "description": "Assigns the audience (recipients) for an unsent mailing.", "x-documentation-page": "Mailings-AudiencePost", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mailings_AudienceArguments" } } } }, "responses": { "200": { "description": "Successful MailingAudienceResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/MailingAudienceResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Mailings/Preview": { "get": { "tags": [ "Mailings" ], "summary": "Preview mailings", "operationId": "Mailings_Preview_Get", "description": "Return the contents of the mailing after applying mail merging for a specific recipient.", "x-documentation-page": "Mailings-Preview", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "mailingTitle", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful PreviewMailing response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PreviewMailing" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Mailings/TestSend": { "get": { "tags": [ "Mailings" ], "summary": "Test send mailings", "operationId": "Mailings_TestSend_Get", "description": "Sends a fully mail-merged copy of the contents to the designated recipient. Links will be processed as clickthroughs but will not be recorded in the database.", "x-documentation-page": "Mailings-TestSend", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "mailingTitle", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Mailings/Queue": { "put": { "tags": [ "Mailings" ], "summary": "Queue mailings", "operationId": "Mailings_Queue_Put", "description": "Send an existing mailing. The delivery should either start immediately or at the time provided. The queueing process can take some time, depending on the number of recipients and the speed of the database. If the operation hasn't completed quickly you will be given a message \"Mailing has been queued. Check back later for the results.\" Use the CheckQueueResults function to get the results.", "x-documentation-page": "Mailings-Queue", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "mailingTitle", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "queueTime", "in": "query", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful QueueMailingResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/QueueMailingResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Mailings/CheckQueueResults": { "get": { "tags": [ "Mailings" ], "summary": "Check queue results mailings", "operationId": "Mailings_CheckQueueResults_Get", "description": "If the call to queue a mailing didn't give the results within the timeout, you can call this function to get the final results. Once you get results once they are not returned again. Only mailings that didn't return the results immediately after the queue will return results with this function.", "x-documentation-page": "Mailings-CheckQueueResults", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "mailingTitle", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful QueueMailingResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/QueueMailingResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Mailings/Report": { "get": { "tags": [ "Mailings" ], "summary": "Report mailings", "operationId": "Mailings_Report_Get", "description": "Provide data about open, clicks, complaints, or deliverability for a specific mailing.", "x-documentation-page": "Mailings-Report", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "reportType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "mailingTitle", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful ReportData response, or a legacy status/error message. userData columns depend on reportType (Clicks, Opens, Deliverability, or Complaints).", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReportData" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/OfflineEvents": { "get": { "tags": [ "OfflineEvents" ], "summary": "Retrieve offline events", "operationId": "OfflineEvents_Retrieve_Get", "description": "Gets basic details for all offline events, or specifics for one offline event.", "x-documentation-page": "OfflineEvents-Get", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "offlineEvent", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful OfflineEventDefinitionResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OfflineEventDefinitionResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "post": { "tags": [ "OfflineEvents" ], "summary": "Create offline events", "operationId": "OfflineEvents_Create_Post", "description": "Create a new Offline Event.", "x-documentation-page": "OfflineEvents-Create", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfflineEvents_CreateArgs" } } } }, "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "delete": { "tags": [ "OfflineEvents" ], "summary": "Offline event delete offline events", "operationId": "OfflineEvents_OfflineEventDelete_Delete", "description": "Remove an Offline Event and all data associated with the event.", "x-documentation-page": "OfflineEvents-Delete", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "offlineEventName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/OfflineEvents/Recipients": { "get": { "tags": [ "OfflineEvents" ], "summary": "Recipients offline events", "operationId": "OfflineEvents_Recipients_Get", "description": "Gets all the recipients in an offline event.", "x-documentation-page": "OfflineEvents-Recipients", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "offlineEvent", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful ReportData response, or a legacy status/error message. userData columns: emailAddress, count.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReportData" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/OfflineEvents/Recipients/Add": { "post": { "tags": [ "OfflineEvents" ], "summary": "Recipients offline events", "operationId": "OfflineEvents_Recipients_Post", "description": "Adds recipients to an offline event.", "x-documentation-page": "OfflineEvents-RecipientsAdd", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfflineEvents_AddRecipients" } } } }, "responses": { "200": { "description": "Successful StringList response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/StringList" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/OfflineEvents/Recipient/Edit": { "post": { "tags": [ "OfflineEvents" ], "summary": "Edit offline events", "operationId": "OfflineEvents_Edit_Post", "description": "Edit an existing row for an offline event.", "x-documentation-page": "OfflineEvents-RecipientsEdit", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfflineEvents_EditRecipientData" } } } }, "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/OfflineEvents/Recipient/Details": { "get": { "tags": [ "OfflineEvents" ], "summary": "Recipient details offline events", "operationId": "OfflineEvents_RecipientDetails_Get", "description": "Gets the column data for one specific recipient.", "x-documentation-page": "OfflineEvents-RecipientsDetails", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "offlineEvent", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful StringRows response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/StringRows" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/OfflineEvents/Recipient/Remove": { "delete": { "tags": [ "OfflineEvents" ], "summary": "Remove offline events", "operationId": "OfflineEvents_Remove_Delete", "description": "Remove a row from an offline event table. Some offline event tables may have more than one row for an email address, so deleting a row based only on the email address will not work. Instead provide the unique ID. The RecipientDetails API will provide the unique ID field.", "x-documentation-page": "OfflineEvents-RecipientsRemove", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "offlineEvent", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "uniqueId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Recipients/Search": { "post": { "tags": [ "Recipients" ], "summary": "Search recipients", "operationId": "Recipients_Search_Post", "description": "Search for recipients based on demographics or topic subscriptions. Combine multiple piece of criteria to filter the results to get just those recipients you want. All demographics are returned.", "x-documentation-page": "Recipients-Search", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Recipients_SearchArgs" } } } }, "responses": { "200": { "description": "Successful ReportDataWithColumns response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReportDataWithColumns" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Recipients/AddMany": { "post": { "tags": [ "Recipients" ], "summary": "Add many recipients", "operationId": "Recipients_AddMany_Post", "description": "Add or update one or more recipients, optionally providing demographic fields. Existing recipients will have their demographics undated, but their unsubscribe status will not be changed so you don't need to fear re-subscribing someone based on this import. The demographics array must have email address as a minimum, and any other demographics provided will update the values for an existing recipient. Empty values do not override existing data. Recipients cannot be added or updated when using a Foreign Members table.", "x-documentation-page": "Recipients-AddMany", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Recipients_AddManyArgs" } } } }, "responses": { "200": { "description": "Successful RecipientImportResultList response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/RecipientImportResultList" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Recipients/AddOne": { "post": { "tags": [ "Recipients" ], "summary": "Add one recipients", "operationId": "Recipients_AddOne_Post", "description": "Add or update one recipient, optionally providing demographic fields. Existing recipients will have their demographics undated, but their unsubscribe status will not be changed so you don't need to fear re-subscribing someone based on this import. Empty demographic values do not override existing data. Recipients cannot be added or updated when using a Foreign Members table. Provide the topics that the person should be subscribed to. If the recipient already exists, they will not be unsubscribed from topics that are not listed.", "x-documentation-page": "Recipients-AddOne", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Recipients_AddOneArgs" } } } }, "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Referrals/Create": { "post": { "tags": [ "Referral" ], "summary": "Create referral", "operationId": "Referral_Create_Post", "description": "Create a refer-a-friend invitation to one or more new email addresses.", "x-documentation-page": "Referrals-Create", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Referrals_CreateArgs" } } } }, "responses": { "200": { "description": "Successful StringMap response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/StringMap" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Referrals/Check": { "post": { "tags": [ "Referral" ], "summary": "Check referral", "operationId": "Referral_Check_Post", "description": "Check the email addresses proposed for adding as referrals.", "x-documentation-page": "Referrals-Check", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Referrals_CheckArgs" } } } }, "responses": { "200": { "description": "Successful StringMap response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/StringMap" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Referrals": { "get": { "tags": [ "Referral" ], "summary": "List referral", "operationId": "Referral_List_Get", "description": "List the referrals for one specific referrer or all those in the database.", "x-documentation-page": "Referrals-List", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful ReferralListResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReferralListResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Segments/CreateFixed": { "post": { "tags": [ "Segments" ], "summary": "Create fixed segments", "operationId": "Segments_CreateFixed_Post", "description": "Create a new fixed segment, providing the set of recipients to use.", "x-documentation-page": "Segments-CreateFixed", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segments_CreateFixedArgs" } } } }, "responses": { "200": { "description": "Successful SegmentBatchResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SegmentBatchResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Segments/RemoveRecipients": { "post": { "tags": [ "Segments" ], "summary": "Remove recipients segments", "operationId": "Segments_RemoveRecipients_Post", "description": "Remove recipients from an existing fixed segment.", "x-documentation-page": "Segments-RemoveRecipients", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segments_RemoveRecipientsArgs" } } } }, "responses": { "200": { "description": "Successful SegmentBatchResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SegmentBatchResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Segments/AddRecipients": { "post": { "tags": [ "Segments" ], "summary": "Add recipients segments", "operationId": "Segments_AddRecipients_Post", "description": "Add recipients to an existing fixed segment.", "x-documentation-page": "Segments-AddRecipients", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segments_AddRecipientsArgs" } } } }, "responses": { "200": { "description": "Successful SegmentAddBatchResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SegmentAddBatchResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Segments/List": { "get": { "tags": [ "Segments" ], "summary": "List segments", "operationId": "Segments_List_Get", "description": "Return information about the current segments.", "x-documentation-page": "Segments-List", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "nameSearch", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." }, { "name": "createDateStart", "in": "query", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "createDateEnd", "in": "query", "required": false, "schema": { "type": [ "string", "null" ], "format": "date-time" } } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful ReportData response, or a legacy status/error message. userData columns: Date created, SegmentId, Name, Description, Creator.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReportData" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Segments": { "delete": { "tags": [ "Segments" ], "summary": "Delete segments", "operationId": "Segments_Delete_Delete", "description": "Remove an existing segment.", "x-documentation-page": "Segments-Delete", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Segments/Execute": { "get": { "tags": [ "Segments" ], "summary": "Execute segments", "operationId": "Segments_Execute_Get", "description": "Execute a segment and return the recipients selected.", "x-documentation-page": "Segments-Execute", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful ReportData response, or a legacy status/error message. userData columns: EmailAddress.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReportData" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Subscriptions/List/Topic": { "get": { "tags": [ "Subscriptions" ], "summary": "List by topic subscriptions", "operationId": "Subscriptions_ListByTopic_Get", "description": "Provide all the subscribed recipients for a topic.", "x-documentation-page": "Subscriptions-ListByTopic", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "topic", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful ReportData response, or a legacy status/error message. userData columns: Email address.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReportData" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Subscriptions/List/Email": { "get": { "tags": [ "Subscriptions" ], "summary": "List by email subscriptions", "operationId": "Subscriptions_ListByEmail_Get", "description": "Show the topic subscriptions for a specific email address.", "x-documentation-page": "Subscriptions-ListByEmail", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful SubscriptionStatusList response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SubscriptionStatusList" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Subscriptions/Change": { "post": { "tags": [ "Subscriptions" ], "summary": "Change subscriptions", "operationId": "Subscriptions_Change_Post", "description": "Alter the subscriptions for a recipient.", "x-documentation-page": "Subscriptions-Change", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscriptions_SubscriptionArgs" } } } }, "responses": { "200": { "description": "Successful StringList response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/StringList" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Subscriptions/Subscribe": { "put": { "tags": [ "Subscriptions" ], "summary": "Subscribe subscriptions", "operationId": "Subscriptions_Subscribe_Put", "description": "Subscribe a single recipient to a specific topic.", "x-documentation-page": "Subscriptions-Subscribe", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "topic", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Subscriptions/Unsubscribe": { "put": { "tags": [ "Subscriptions" ], "summary": "Unsubscribe subscriptions", "operationId": "Subscriptions_Unsubscribe_Put", "description": "Unsubscribe a single recipient from a specific topic.", "x-documentation-page": "Subscriptions-Unsubscribe", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "topic", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "mailingTitle", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Suppression/Global/Check": { "get": { "tags": [ "Suppression" ], "summary": "Check suppression", "operationId": "Suppression_Check1_Get", "description": "Check if a single recipient is globally suppressed or not.", "x-documentation-page": "Suppression-GlobalCheck", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful SuppressionCount response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SuppressionCount" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Suppression/Global/Add": { "put": { "tags": [ "Suppression" ], "summary": "Add one suppression", "operationId": "Suppression_AddOne1_Put", "description": "Add a recipient to the global suppression list.", "x-documentation-page": "Suppression-GlobalAddOne", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "post": { "tags": [ "Suppression" ], "summary": "Add many suppression", "operationId": "Suppression_AddMany1_Post", "description": "Add many recipients to the global suppression list.", "x-documentation-page": "Suppression-GlobalAddMany", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Suppression_SuppressionEmails" } } } }, "responses": { "200": { "description": "Successful SuppressionBatchResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SuppressionBatchResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Suppression/Global/Remove": { "delete": { "tags": [ "Suppression" ], "summary": "Remove one suppression", "operationId": "Suppression_RemoveOne1_Delete", "description": "Remove a recipient from the global suppression list.", "x-documentation-page": "Suppression-GlobalRemoveOne", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "post": { "tags": [ "Suppression" ], "summary": "Remove many suppression", "operationId": "Suppression_RemoveMany1_Post", "description": "Remove many recipients from the global suppression list.", "x-documentation-page": "Suppression-GlobalRemoveMany", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Suppression_SuppressionEmails" } } } }, "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Suppression/Topic/Check": { "get": { "tags": [ "Suppression" ], "summary": "Check suppression", "operationId": "Suppression_Check2_Get", "description": "Check if a single recipient is on a topic suppression list.", "x-documentation-page": "Suppression-TopicCheck", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "topicName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful SuppressionCount response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SuppressionCount" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Suppression/Topic/Add": { "put": { "tags": [ "Suppression" ], "summary": "Add one suppression", "operationId": "Suppression_AddOne2_Put", "description": "Add a recipient to a topic suppression list.", "x-documentation-page": "Suppression-TopicAddOne", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "topicName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "post": { "tags": [ "Suppression" ], "summary": "Add many suppression", "operationId": "Suppression_AddMany2_Post", "description": "Add many recipients to a topic suppression list.", "x-documentation-page": "Suppression-TopicAddMany", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Suppression_SuppressionTopicEmails" } } } }, "responses": { "200": { "description": "Successful SuppressionBatchResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SuppressionBatchResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Suppression/Topic/Remove": { "delete": { "tags": [ "Suppression" ], "summary": "Remove one suppression", "operationId": "Suppression_RemoveOne2_Delete", "description": "Remove a recipient from a topic suppression list.", "x-documentation-page": "Suppression-TopicRemoveOne", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "topicName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "post": { "tags": [ "Suppression" ], "summary": "Remove many suppression", "operationId": "Suppression_RemoveMany2_Post", "description": "Remove many recipients from a topic suppression list.", "x-documentation-page": "Suppression-TopicRemoveMany", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Suppression_SuppressionTopicEmails" } } } }, "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Topics": { "post": { "tags": [ "Topics" ], "summary": "Create topics", "operationId": "Topics_Create_Post", "description": "Create a new topic. Topics are used to record unsubscribes, and to keep some defaults for newly created mailings and documents. Do not create a new topic simply for the purpose of defining a list. Instead use segmentation to target the recipients you want. Most fields in the topic are optional, in which case their value will be copied from the global settings. There are a few additional values for a topic that can be set through the web interface.", "x-documentation-page": "Topics-Create", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Topics_CreationArgs" } } } }, "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "get": { "tags": [ "Topics" ], "summary": "List topics", "operationId": "Topics_List_Get", "description": "Provide the basic details for the topics.", "x-documentation-page": "Topics-List", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful TopicSummaryList response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TopicSummaryList" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } }, "delete": { "tags": [ "Topics" ], "summary": "Remove topics", "operationId": "Topics_Remove_Delete", "description": "Remove an unused topic. Once a topic has been used to record unsubscribes for a mailing or document it can no longer be removed or the unsubscribe information would be lost.", "x-documentation-page": "Topics-Remove", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "topicName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful LegacyStatusMessage response, or a legacy status/error message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Utility/GetFile": { "get": { "tags": [ "Utility" ], "summary": "Get file utility", "operationId": "Utility_GetFile_Get", "description": "Retrieve the entire contents of a large data export. When an API call results in too much data to return in a single call, the call provides a GUID that can be referenced to download the entire results. Simply call this function, providing the GUID, and the data will be returned as an attachment. Note that the file contents will be in CSV format instead of JSON.", "x-documentation-page": "Utility-GetFile", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "fileNameGuid", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "The requested export file, or a plain-text file-name/backend error.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "500": { "description": "An unhandled exception occurred while transferring the file." } } } }, "/API/Rest/Utility/CheckSystem": { "get": { "tags": [ "Utility" ], "summary": "Check system utility", "operationId": "Utility_CheckSystem_Get", "description": "Check the system for warning signs of problems. This function is designed to give a few key metrics on the system without causing much load on the database to perform these checks. In order to minimize the impact on the database for running this API call, the results are based off the last 1,000,000 mail queue sending records. In some unusual cases this might not represent the current activity of the system, but should be a good metric in most circumstances. It is difficult to development methodologies that would always recognize system issues as they are very customer-specific. No clickthroughs for several hours could be an indication of problems for some high volume senders, where in other cases emails are sent less frequently so low customer involvement is expected. You will need to know something about the load on your system and what that means for these metrics. For example, if you monitor the delayedMailQueueRecords shortly after you post a large mailing, depending on your system speed, you may see some records listed as being delayed. However, that wouldn't be a concern since you know that a large posting was just submitted. We recommend that you analyze your own system performance to build up a baseline, and then you can have this API warn you if anything falls outside of your baseline. For example, if you determine that your system regularly takes 100 ms to resolve these database queries, you might set an alarm if it takes 200 ms. But someone else's database might take 500 ms, so they would want a different alarm point. Although these system metrics are designed to be retreived with a minimal load on the system, it is recommended that you run this routine with at least five minutes between calls.", "x-documentation-page": "Utility-CheckSystem", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful SystemStats response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SystemStats" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Workflows/List": { "get": { "tags": [ "Workflows" ], "summary": "List workflows", "operationId": "Workflows_List_Get", "description": "List the workflows", "x-documentation-page": "Workflows-List", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful WorkflowSummaryList response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/WorkflowSummaryList" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Workflows/Status": { "get": { "tags": [ "Workflows" ], "summary": "Status workflows", "operationId": "Workflows_Status_Get", "description": "Provide the status of a specific recipient in a workflow.", "x-documentation-page": "Workflows-Status", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "emailAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "workflowName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful WorkflowRecipientInstanceList response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/WorkflowRecipientInstanceList" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Workflows/Add": { "post": { "tags": [ "Workflows" ], "summary": "Add workflows", "operationId": "Workflows_Add_Post", "description": "Add multiple recipients into an existing workflow", "x-documentation-page": "Workflows-AddMany", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflows_AddArgs" } } } }, "responses": { "200": { "description": "Successful WorkflowAddBatchResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/WorkflowAddBatchResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Workflows/Remove": { "post": { "tags": [ "Workflows" ], "summary": "Remove workflows", "operationId": "Workflows_Remove_Post", "description": "Remove many recipients from a workflow.", "x-documentation-page": "Workflows-RemoveMany", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflows_RemoveArgs" } } } }, "responses": { "200": { "description": "Successful WorkflowRemoveBatchResult response, or a legacy status/error message.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/WorkflowRemoveBatchResult" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "400": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } }, "/API/Rest/Subscriptions/Unsubscribes/List": { "get": { "tags": [ "Subscriptions" ], "summary": "List unsubscribed recipients for a topic", "operationId": "Subscriptions_UnsubscribesList_Get", "description": "Provide all unsubscribed recipients for a topic, optionally filtered by date.", "x-documentation-page": "Subscriptions-UnsubscribesList", "parameters": [ { "name": "accountName", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Symphonie account name." }, { "name": "login", "in": "query", "required": true, "schema": { "type": "string" }, "description": "API login name." }, { "name": "topic", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0, "maximum": 10 }, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version." }, { "name": "endDate", "in": "query", "required": false, "description": "Optional cutoff date. Only recipients whose unsubscribe date is later than this date are returned, avoiding repeated downloads of the complete history.", "schema": { "type": "string", "format": "date" } } ], "security": [ { "PasswordHeader": [] }, { "PasswordQuery": [] } ], "responses": { "200": { "description": "Successful ReportData response, or a legacy status/error message. userData columns: Email address, Email Unsubscribe Date, Mailing Title.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ReportData" }, { "$ref": "#/components/schemas/LegacyStatusMessage" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } }, "401": { "$ref": "#/components/responses/CannotDetermineIpAddress" } } } } }, "components": { "securitySchemes": { "PasswordHeader": { "type": "apiKey", "in": "header", "name": "Password", "description": "Preferred authentication location for GET, PUT, and DELETE operations." }, "PasswordQuery": { "type": "apiKey", "in": "query", "name": "password", "description": "Convenient for direct browser testing, but the password can be recorded in browser history and server or proxy logs. Prefer the Password header for application integrations." } }, "schemas": { "Confirmations_SendMultipleConfirmationsArgs": { "type": "object", "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "documentName": { "type": "string" } }, "additionalProperties": false, "required": [ "emailAddresses", "accountName", "login", "password", "documentName" ] }, "ContentBlocks_CreateContentBlockArgs": { "type": "object", "properties": { "text": { "type": "string" }, "html": { "type": "string" }, "delimiterStart": { "type": "string" }, "delimiterEnd": { "type": "string" }, "description": { "type": "string" }, "culture": { "type": "string" }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "name": { "type": "string" }, "replaceExisting": { "type": "boolean" } }, "additionalProperties": false, "required": [ "accountName", "login", "password", "name", "replaceExisting" ] }, "Demographics_CreateArgs": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "columnName": { "type": "string" }, "dataType": { "type": "string" }, "exportWithReports": { "type": "boolean" }, "displayInSearchResults": { "type": "boolean" } }, "additionalProperties": false, "required": [ "accountName", "login", "password", "columnName", "dataType", "exportWithReports", "displayInSearchResults" ] }, "Documents_CreateDocumentArguments": { "type": "object", "properties": { "documentText": { "type": "string" }, "documentHtml": { "type": "string" }, "charsetId": { "type": "string" }, "delimiterStart": { "type": "string" }, "delimiterEnd": { "type": "string" }, "headerFrom": { "type": "string" }, "headerTo": { "type": "string" }, "bodyLanguageId": { "type": "string" }, "replyTo": { "type": "string" }, "additionalHeaders": { "type": "object", "additionalProperties": { "type": "string" } }, "priority": { "type": [ "integer", "null" ], "format": "int32" }, "trackedLinks": { "type": "array", "items": { "type": "string" } }, "trackAllLinks": { "type": "boolean" }, "recipientLoggingLevel": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 1 }, "detectOpens": { "type": "boolean" }, "virtualIpGroup": { "type": "string" }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "documentName": { "type": "string" }, "subject": { "type": "string" }, "unsubscribeTopic": { "type": "string" } }, "additionalProperties": false, "required": [ "accountName", "login", "password", "documentName", "subject", "unsubscribeTopic" ] }, "Documents_EditDocumentArguments": { "type": "object", "properties": { "documentName": { "type": "string" }, "documentText": { "type": "string" }, "documentHtml": { "type": "string" }, "charsetId": { "type": "string" }, "delimiterStart": { "type": "string" }, "delimiterEnd": { "type": "string" }, "headerFrom": { "type": "string" }, "headerTo": { "type": "string" }, "subject": { "type": "string" }, "bodyLanguageId": { "type": "string" }, "replyTo": { "type": "string" }, "additionalHeaders": { "type": "object", "additionalProperties": { "type": "string" } }, "priority": { "type": [ "integer", "null" ], "format": "int32" }, "trackedLinks": { "type": "array", "items": { "type": "string" } }, "trackAllLinks": { "type": [ "boolean", "null" ] }, "recipientLoggingLevel": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 1 }, "unsubscribeTopic": { "type": "string" }, "detectOpens": { "type": [ "boolean", "null" ] }, "virtualIpGroup": { "type": "string" }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 } }, "additionalProperties": false, "required": [ "documentName", "accountName", "login", "password" ] }, "Documents_GetDocumentArguments": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "documents": { "type": "array", "items": { "type": "string" } }, "topic": { "type": "string" }, "sentStart": { "type": [ "string", "null" ], "format": "date-time" }, "sentEnd": { "type": [ "string", "null" ], "format": "date-time" } }, "additionalProperties": false, "required": [ "accountName", "login", "password" ] }, "Documents_PreviewArguments": { "type": "object", "properties": { "substitutions": { "type": "object", "additionalProperties": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "documentName": { "type": "string" }, "emailAddress": { "type": "string" } }, "additionalProperties": false, "required": [ "substitutions", "accountName", "login", "password", "documentName", "emailAddress" ] }, "Documents_QueueArguments": { "type": "object", "properties": { "substitutions": { "type": "object", "additionalProperties": { "type": "string" } }, "checkTopicUnsubscribes": { "type": "boolean" }, "checkUnconfirmed": { "type": "boolean" }, "reportCategory": { "type": "string", "maxLength": 25 }, "sendDateTime": { "type": [ "string", "null" ], "format": "date-time" }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "documentName": { "type": "string" }, "emailAddress": { "type": "string" } }, "additionalProperties": false, "required": [ "accountName", "login", "password", "documentName", "emailAddress" ] }, "Documents_TestSendArguments": { "type": "object", "properties": { "substitutions": { "type": "object", "additionalProperties": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "documentName": { "type": "string" }, "emailAddress": { "type": "string" } }, "additionalProperties": false, "required": [ "substitutions", "accountName", "login", "password", "documentName", "emailAddress" ] }, "Documents_ReportArguments": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "string" } }, "startTime": { "type": [ "string", "null" ], "format": "date-time" }, "endTime": { "type": [ "string", "null" ], "format": "date-time" }, "reportCategory": { "type": "string" }, "demographicColumn": { "type": "string" }, "demographicValue": { "type": "string" }, "virtualIpGroup": { "type": "string" }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "reportType": { "type": "string" } }, "additionalProperties": false, "required": [ "accountName", "login", "password", "reportType" ] }, "GlobalUnsubscribes_GlobalUnsubscribesEmails": { "type": "object", "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 } }, "additionalProperties": false, "required": [ "emailAddresses", "accountName", "login", "password" ] }, "HeldRecipients_AddHeldRecipients": { "type": "object", "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 } }, "additionalProperties": false, "required": [ "emailAddresses", "accountName", "login", "password" ] }, "Mailings_GetMailingArguments": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "titles": { "type": "array", "items": { "type": "string" } }, "topic": { "type": "string" }, "sentStart": { "type": [ "string", "null" ], "format": "date-time" }, "sentEnd": { "type": [ "string", "null" ], "format": "date-time" }, "subject": { "type": "string" }, "bodyText": { "type": "string" } }, "additionalProperties": false, "required": [ "accountName", "login", "password" ] }, "Mailings_CreateMailingArguments": { "type": "object", "properties": { "textBody": { "type": "string" }, "htmlBody": { "type": "string" }, "charsetId": { "type": "string" }, "delimiterStart": { "type": "string" }, "delimiterEnd": { "type": "string" }, "headerFrom": { "type": "string" }, "bodyLanguageId": { "type": "string" }, "replyTo": { "type": "string" }, "additionalHeaders": { "type": "object", "additionalProperties": { "type": "string" } }, "priority": { "type": [ "integer", "null" ], "format": "int32" }, "trackedLinks": { "type": "array", "items": { "type": "string" } }, "trackAllLinks": { "type": "boolean" }, "recipientLoggingLevel": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 1 }, "unsubscribeTopic": { "type": "string" }, "detectOpens": { "type": "boolean" }, "virtualIpGroup": { "type": "string" }, "segmentName": { "type": "string" }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "mailingTitle": { "type": "string" }, "subject": { "type": "string" } }, "additionalProperties": false, "required": [ "accountName", "login", "password", "mailingTitle", "subject" ] }, "Mailings_AudienceArguments": { "type": "object", "properties": { "recipients": { "type": "array", "items": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "mailingTitle": { "type": "string" }, "replaceExisting": { "type": "boolean" } }, "additionalProperties": false, "required": [ "recipients", "accountName", "login", "password", "mailingTitle", "replaceExisting" ] }, "OfflineEvents_AddRecipients": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "string" } }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "offlineEvent": { "type": "string" } }, "additionalProperties": false, "required": [ "columns", "data", "accountName", "login", "password", "offlineEvent" ] }, "OfflineEvents_EditRecipientData": { "type": "object", "properties": { "replacementValues": { "type": "object", "additionalProperties": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "offlineEventName": { "type": "string" }, "emailAddress": { "type": "string" }, "uniqueId": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "required": [ "replacementValues", "accountName", "login", "password", "offlineEventName", "emailAddress", "uniqueId" ] }, "OfflineEvents_ColumnDefinition": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "columnType": { "type": "string" }, "allowNull": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "columnType", "allowNull" ] }, "OfflineEvents_CreateArgs": { "type": "object", "properties": { "description": { "type": "string" }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/OfflineEvents_ColumnDefinition" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "columns", "accountName", "login", "password", "name" ] }, "Recipients_SearchArgs": { "type": "object", "properties": { "topicName": { "type": "string" }, "searchDemographics": { "type": "array", "items": { "type": "string" } }, "searchCriterias": { "type": "array", "items": { "type": "string" } }, "searchValues": { "type": "array", "items": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 } }, "additionalProperties": false, "required": [ "accountName", "login", "password" ] }, "Recipients_AddManyArgs": { "type": "object", "properties": { "importType": { "type": "string" }, "topics": { "type": "array", "items": { "type": "string" } }, "document": { "type": "string" }, "documentOptions": { "type": "string" }, "fixedSegmentName": { "type": "string" }, "demographics": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "culture": { "type": "string" } }, "additionalProperties": false, "required": [ "accountName", "login", "password", "culture" ] }, "Recipients_AddOneArgs": { "type": "object", "properties": { "topics": { "type": "array", "items": { "type": "string" } }, "demographics": { "type": "object", "additionalProperties": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "emailAddress": { "type": "string" } }, "additionalProperties": false, "required": [ "accountName", "login", "password", "emailAddress" ] }, "ReferralRecipientInfo": { "type": "object", "properties": { "Name": { "type": "string" }, "EmailAddress": { "type": "string" } }, "additionalProperties": false }, "Referrals_CreateArgs": { "type": "object", "properties": { "referrerComment": { "type": "string" }, "referrees": { "type": "array", "items": { "$ref": "#/components/schemas/ReferralRecipientInfo" } }, "mailQueueId": { "type": [ "integer", "null" ], "format": "int64" }, "documentName": { "type": "string" }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "referrerEmailAddress": { "type": "string" } }, "additionalProperties": false, "required": [ "accountName", "login", "password", "referrerEmailAddress" ] }, "Referrals_CheckArgs": { "type": "object", "properties": { "mailQueueId": { "type": [ "integer", "null" ], "format": "int64" }, "referrees": { "type": "array", "items": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "referrerEmailAddress": { "type": "string" } }, "additionalProperties": false, "required": [ "accountName", "login", "password", "referrerEmailAddress" ] }, "Segments_CreateFixedArgs": { "type": "object", "properties": { "description": { "type": "string" }, "emailAddresses": { "type": "array", "items": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "emailAddresses", "accountName", "login", "password", "name" ] }, "Segments_RemoveRecipientsArgs": { "type": "object", "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "emailAddresses", "accountName", "login", "password", "name" ] }, "Segments_AddRecipientsArgs": { "type": "object", "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "name": { "type": "string" } }, "additionalProperties": false, "required": [ "emailAddresses", "accountName", "login", "password", "name" ] }, "Subscriptions_SubscriptionArgs": { "type": "object", "properties": { "subscribedTopics": { "type": "array", "items": { "type": "string" } }, "unsubscribedTopics": { "type": "array", "items": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "emailAddress": { "type": "string" } }, "additionalProperties": false, "required": [ "accountName", "login", "password", "emailAddress" ] }, "Suppression_SuppressionEmails": { "type": "object", "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 } }, "additionalProperties": false, "required": [ "emailAddresses", "accountName", "login", "password" ] }, "Suppression_SuppressionTopicEmails": { "type": "object", "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "topicName": { "type": "string" } }, "additionalProperties": false, "required": [ "emailAddresses", "accountName", "login", "password", "topicName" ] }, "Topics_CreationArgs": { "type": "object", "properties": { "replyTo": { "type": "string" }, "headerFrom": { "type": "string" }, "charsetId": { "type": "string" }, "bodyLanguageId": { "type": "string" }, "priority": { "type": [ "integer", "null" ], "format": "int32" }, "virtualIpGroup": { "type": "string" }, "delimiterStart": { "type": "string" }, "delimiterEnd": { "type": "string" }, "additionalHeaders": { "type": "object", "additionalProperties": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "name": { "type": "string" }, "description": { "type": "string" }, "recipientLoggingLevel": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 1 } }, "additionalProperties": false, "required": [ "accountName", "login", "password", "name", "description" ] }, "Workflows_AddArgs": { "type": "object", "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" } }, "instanceData": { "type": "object", "additionalProperties": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "workflowName": { "type": "string" } }, "additionalProperties": false, "required": [ "emailAddresses", "accountName", "login", "password", "workflowName" ] }, "Workflows_RemoveArgs": { "type": "object", "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" } }, "accountName": { "type": "string", "description": "Symphonie account name." }, "login": { "type": "string", "description": "API login name." }, "password": { "type": "string", "description": "API password.", "writeOnly": true }, "apiVersion": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10, "description": "Reserved request field in Symphonie 4.8. It defaults to 0 and does not change Release4.8 behavior; it is separate from this OpenAPI contract version.", "default": 0 }, "workflowName": { "type": "string" } }, "additionalProperties": false, "required": [ "emailAddresses", "accountName", "login", "password", "workflowName" ] }, "LegacyStatusMessage": { "type": "string", "description": "A legacy success, validation, permission, or backend error message. The API frequently sends this as unquoted text while labeling the response application/json." }, "StringList": { "type": "array", "items": { "type": "string" } }, "StringMap": { "type": "object", "additionalProperties": { "type": "string" } }, "StringRows": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "ReportData": { "type": "object", "description": "Large-data response envelope. userData contains the first page of endpoint-specific string rows; downloadGuid can be passed to Utility/GetFile to retrieve the complete export.", "additionalProperties": false, "required": [ "downloadGuid", "totalRows", "userData" ], "properties": { "downloadGuid": { "type": "string", "format": "uuid" }, "totalRows": { "type": "integer", "format": "int32", "minimum": 0 }, "userData": { "$ref": "#/components/schemas/StringRows" } } }, "ReportDataWithColumns": { "type": "object", "description": "Search response with ordered column names and string-valued rows.", "additionalProperties": false, "required": [ "downloadGuid", "totalRows", "columns", "userData" ], "properties": { "downloadGuid": { "type": "string", "format": "uuid" }, "totalRows": { "type": "integer", "format": "int32", "minimum": 0 }, "columns": { "$ref": "#/components/schemas/StringList" }, "userData": { "$ref": "#/components/schemas/StringRows" } } }, "PreviewDocument": { "type": "object", "additionalProperties": false, "required": [ "textBody", "htmlBody", "headers", "recipientId", "emailAddress", "documentId", "errorMessage" ], "properties": { "textBody": { "type": "string" }, "htmlBody": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "recipientId": { "type": "integer", "format": "int32" }, "emailAddress": { "type": "string" }, "documentId": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string" } } }, "DocumentDetails": { "type": "object", "additionalProperties": false, "required": [ "documentName", "documentId", "documentText", "documentHtml", "charsetId", "delimiterStart", "delimiterEnd", "headerFrom", "headerTo", "subject", "bodyLanguageId", "replyTo", "additionalHeaders", "priority", "trackedLinks", "recipientLoggingLevel", "unsubscribeTopic", "detectOpens", "virtualIpGroup" ], "properties": { "documentName": { "type": "string" }, "documentId": { "type": "integer", "format": "int32" }, "documentText": { "type": [ "string", "null" ] }, "documentHtml": { "type": [ "string", "null" ] }, "charsetId": { "type": "integer", "format": "int32" }, "delimiterStart": { "type": [ "string", "null" ] }, "delimiterEnd": { "type": [ "string", "null" ] }, "headerFrom": { "type": [ "string", "null" ] }, "headerTo": { "type": [ "string", "null" ] }, "subject": { "type": [ "string", "null" ] }, "bodyLanguageId": { "type": "integer", "format": "int32" }, "replyTo": { "type": [ "string", "null" ] }, "additionalHeaders": { "type": "object", "additionalProperties": { "type": "string" } }, "priority": { "type": "integer", "format": "int32" }, "trackedLinks": { "$ref": "#/components/schemas/StringList" }, "recipientLoggingLevel": { "type": [ "string", "null" ] }, "unsubscribeTopic": { "type": [ "string", "null" ] }, "detectOpens": { "type": "boolean" }, "virtualIpGroup": { "type": [ "string", "null" ] } } }, "MailingDetails": { "type": "object", "additionalProperties": false, "required": [ "textBody", "htmlBody", "title", "subject", "mailingId", "charsetId", "delimiterStart", "delimiterEnd", "headerFrom", "headerTo", "bodyLanguageId", "replyTo", "otherSplitIds", "additionalHeaders", "priority", "trackedLinks", "recipientLoggingLevel", "unsubscribeTopic", "detectOpens", "virtualIpGroup", "status" ], "properties": { "textBody": { "type": [ "string", "null" ] }, "htmlBody": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "subject": { "type": [ "string", "null" ] }, "mailingId": { "type": "integer", "format": "int32" }, "charsetId": { "type": "integer", "format": "int32" }, "delimiterStart": { "type": [ "string", "null" ] }, "delimiterEnd": { "type": [ "string", "null" ] }, "headerFrom": { "type": [ "string", "null" ] }, "headerTo": { "type": [ "string", "null" ] }, "bodyLanguageId": { "type": "integer", "format": "int32" }, "replyTo": { "type": [ "string", "null" ] }, "otherSplitIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "additionalHeaders": { "type": "object", "additionalProperties": { "type": "string" } }, "priority": { "type": "integer", "format": "int32" }, "trackedLinks": { "$ref": "#/components/schemas/StringList" }, "recipientLoggingLevel": { "type": [ "string", "null" ] }, "unsubscribeTopic": { "type": [ "string", "null" ] }, "detectOpens": { "type": "boolean" }, "virtualIpGroup": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ], "description": "Mailing state such as unsent, pending, stopped, or sent." } } }, "SystemStats": { "type": "object", "additionalProperties": false, "required": [ "delayedMailQueueRecords", "lastMailingOpen", "lastDocumentOpen", "lastMailingClick", "lastDocumentClick", "maxLicensedRecipients", "currentRecipientCount", "dbResponsiveness", "isLicenseExpired" ], "properties": { "delayedMailQueueRecords": { "type": "integer", "format": "int32" }, "lastMailingOpen": { "type": [ "string", "null" ], "format": "date-time" }, "lastDocumentOpen": { "type": [ "string", "null" ], "format": "date-time" }, "lastMailingClick": { "type": [ "string", "null" ], "format": "date-time" }, "lastDocumentClick": { "type": [ "string", "null" ], "format": "date-time" }, "maxLicensedRecipients": { "type": "integer", "format": "int32" }, "currentRecipientCount": { "type": "integer", "format": "int32" }, "dbResponsiveness": { "type": "integer", "format": "int32" }, "isLicenseExpired": { "type": "boolean" } } }, "MailingAudienceResult": { "type": "object", "additionalProperties": false, "required": [ "successfullyAdded", "badRecipients", "duplicatedInInput", "alreadyInMailing" ], "properties": { "successfullyAdded": { "type": "integer", "format": "int32", "minimum": 0 }, "badRecipients": { "$ref": "#/components/schemas/StringList" }, "duplicatedInInput": { "$ref": "#/components/schemas/StringList" }, "alreadyInMailing": { "$ref": "#/components/schemas/StringList" } } }, "PreviewMailing": { "type": "object", "additionalProperties": false, "required": [ "textBody", "htmlBody", "headers", "recipientId", "emailAddress", "mailingId" ], "properties": { "textBody": { "type": "string" }, "htmlBody": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "recipientId": { "type": "integer", "format": "int32" }, "emailAddress": { "type": "string" }, "mailingId": { "type": "integer", "format": "int32" } } }, "QueueMailingResult": { "type": "object", "additionalProperties": false, "required": [ "heldMembers", "totalUnconfirmedMembers", "totalUnsubscribedMembers", "totalRecencyMembers", "totalSuppressedMembers", "fccBans", "totalRecords" ], "properties": { "heldMembers": { "$ref": "#/components/schemas/StringList" }, "totalUnconfirmedMembers": { "type": "integer", "format": "int32", "minimum": 0 }, "totalUnsubscribedMembers": { "type": "integer", "format": "int32", "minimum": 0 }, "totalRecencyMembers": { "type": "integer", "format": "int32", "minimum": 0 }, "totalSuppressedMembers": { "type": "integer", "format": "int32", "minimum": 0 }, "fccBans": { "type": "integer", "format": "int32", "minimum": 0 }, "totalRecords": { "type": "integer", "format": "int32", "minimum": 0 } } }, "ConfirmationStatus": { "type": "object", "additionalProperties": false, "required": [ "SentConfirm", "Confirmed" ], "properties": { "SentConfirm": { "type": [ "string", "null" ], "description": "Localized date and time, or null." }, "Confirmed": { "type": [ "string", "null" ], "description": "Localized date and time, or null." } } }, "ConfirmationBatchResult": { "type": "object", "additionalProperties": false, "required": [ "invalidEmailAddresses", "duplicateInFile", "alreadyConfirmed" ], "properties": { "invalidEmailAddresses": { "$ref": "#/components/schemas/StringList" }, "duplicateInFile": { "$ref": "#/components/schemas/StringList" }, "alreadyConfirmed": { "$ref": "#/components/schemas/StringList" } } }, "ContentBlock": { "type": "object", "additionalProperties": false, "required": [ "name", "text", "html", "delimiterStart", "delimiterEnd", "description", "culture" ], "properties": { "name": { "type": [ "string", "null" ] }, "text": { "type": [ "string", "null" ] }, "html": { "type": [ "string", "null" ] }, "delimiterStart": { "type": [ "string", "null" ] }, "delimiterEnd": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "culture": { "type": [ "string", "null" ] } } }, "HeldRecipientsBatchResult": { "type": "object", "additionalProperties": false, "required": [ "alreadyHeld", "notInDatabase", "duplicateInFile" ], "properties": { "alreadyHeld": { "$ref": "#/components/schemas/StringList" }, "notInDatabase": { "$ref": "#/components/schemas/StringList" }, "duplicateInFile": { "$ref": "#/components/schemas/StringList" } } }, "OfflineEventSummary": { "type": "object", "additionalProperties": false, "required": [ "name", "description" ], "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] } } }, "OfflineEventColumn": { "type": "object", "additionalProperties": false, "required": [ "columnName", "description", "dataType", "allowNull" ], "properties": { "columnName": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "dataType": { "type": "string" }, "allowNull": { "type": "boolean" } } }, "OfflineEventDefinitionResult": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/OfflineEventSummary" } }, { "type": "array", "items": { "$ref": "#/components/schemas/OfflineEventColumn" } } ], "description": "Without name, returns offline-event summaries. With name, returns that event's column definitions." }, "RecipientImportResult": { "type": "object", "additionalProperties": false, "required": [ "emailAddress", "recipientId", "importMessage" ], "properties": { "emailAddress": { "type": [ "string", "null" ] }, "recipientId": { "type": "integer", "format": "int32" }, "importMessage": { "type": [ "string", "null" ] } } }, "ReferralSummary": { "type": "object", "additionalProperties": false, "required": [ "emailAddress", "requestDate", "enrollDate" ], "properties": { "emailAddress": { "type": "string" }, "requestDate": { "type": "string", "format": "date-time" }, "enrollDate": { "type": [ "string", "null" ], "format": "date-time" } } }, "ReferralListResult": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ReferralSummary" } }, { "$ref": "#/components/schemas/ReportData" } ], "description": "With emailAddress, returns referral summaries. Without emailAddress, returns the large-data report envelope." }, "DemographicDefinition": { "type": "object", "additionalProperties": false, "required": [ "ColumnName", "DataType", "DisplayInSearchResults", "ExportWithReports" ], "properties": { "ColumnName": { "type": "string" }, "DataType": { "type": "string" }, "DisplayInSearchResults": { "type": "boolean" }, "ExportWithReports": { "type": "boolean" } } }, "SegmentBatchResult": { "type": "object", "additionalProperties": false, "required": [ "duplicateInFile", "badRecipients" ], "properties": { "duplicateInFile": { "$ref": "#/components/schemas/StringList" }, "badRecipients": { "$ref": "#/components/schemas/StringList" } } }, "SegmentAddBatchResult": { "type": "object", "additionalProperties": false, "required": [ "duplicateInFile", "alreadyInSegment", "badRecipients" ], "properties": { "duplicateInFile": { "$ref": "#/components/schemas/StringList" }, "alreadyInSegment": { "$ref": "#/components/schemas/StringList" }, "badRecipients": { "$ref": "#/components/schemas/StringList" } } }, "SubscriptionStatus": { "type": "object", "additionalProperties": false, "required": [ "topicName", "topicId", "subscribed", "subscribeDate", "unsubscribeDate" ], "properties": { "topicName": { "type": "string" }, "topicId": { "type": "integer", "format": "int32" }, "subscribed": { "type": "boolean" }, "subscribeDate": { "type": [ "string", "null" ], "description": "Localized date and time, or null." }, "unsubscribeDate": { "type": [ "string", "null" ], "description": "Localized date and time, or null." } } }, "SuppressionBatchResult": { "type": "object", "additionalProperties": false, "required": [ "duplicateEntries", "invalidEmailAddresses", "alreadySuppressed" ], "properties": { "duplicateEntries": { "$ref": "#/components/schemas/StringList" }, "invalidEmailAddresses": { "$ref": "#/components/schemas/StringList" }, "alreadySuppressed": { "$ref": "#/components/schemas/StringList" } } }, "SuppressionCount": { "type": "integer", "format": "int32", "minimum": 0, "description": "Number of matching suppression records; normally 0 or 1." }, "TopicSummary": { "type": "object", "additionalProperties": false, "required": [ "name", "description", "id" ], "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "id": { "type": "integer", "format": "int32" } } }, "GlobalUnsubscribeBatchAddResult": { "type": "object", "additionalProperties": false, "required": [ "duplicatedInFile", "invalidEmailAddresses", "alreadyUnsubscribed" ], "properties": { "duplicatedInFile": { "$ref": "#/components/schemas/StringList" }, "invalidEmailAddresses": { "$ref": "#/components/schemas/StringList" }, "alreadyUnsubscribed": { "$ref": "#/components/schemas/StringList" } } }, "GlobalUnsubscribeBatchRemoveResult": { "type": "object", "additionalProperties": false, "required": [ "duplicatedInFile", "notOnList" ], "properties": { "duplicatedInFile": { "$ref": "#/components/schemas/StringList" }, "notOnList": { "$ref": "#/components/schemas/StringList" } } }, "WorkflowSummary": { "type": "object", "additionalProperties": false, "required": [ "name", "description", "status" ], "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "status": { "type": "string" } } }, "WorkflowRecipientInstance": { "type": "object", "additionalProperties": false, "required": [ "EnteredWorkflow", "LastActivity", "LastNodeType", "MemberInstance" ], "properties": { "EnteredWorkflow": { "type": "string", "description": "Localized date and time." }, "LastActivity": { "type": "string", "description": "Localized date and time." }, "LastNodeType": { "type": [ "string", "null" ] }, "MemberInstance": { "type": "integer", "format": "int32" } } }, "WorkflowAddBatchResult": { "type": "object", "additionalProperties": false, "required": [ "notInDatabase", "duplicateInFile", "currentlyInWorkflow", "previouslyInWorkflow" ], "properties": { "notInDatabase": { "$ref": "#/components/schemas/StringList" }, "duplicateInFile": { "$ref": "#/components/schemas/StringList" }, "currentlyInWorkflow": { "$ref": "#/components/schemas/StringList" }, "previouslyInWorkflow": { "$ref": "#/components/schemas/StringList" } } }, "WorkflowRemoveBatchResult": { "type": "object", "additionalProperties": false, "required": [ "duplicateEntries", "notInWorkflow" ], "properties": { "duplicateEntries": { "$ref": "#/components/schemas/StringList" }, "notInWorkflow": { "$ref": "#/components/schemas/StringList" } } }, "ValidationProblem": { "type": "object", "required": [ "Message" ], "properties": { "Message": { "type": "string" }, "ModelState": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "DemographicDefinitionList": { "type": "array", "items": { "$ref": "#/components/schemas/DemographicDefinition" } }, "RecipientImportResultList": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientImportResult" } }, "SubscriptionStatusList": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionStatus" } }, "TopicSummaryList": { "type": "array", "items": { "$ref": "#/components/schemas/TopicSummary" } }, "WorkflowSummaryList": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowSummary" } }, "WorkflowRecipientInstanceList": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRecipientInstance" } } }, "responses": { "ValidationError": { "description": "The JSON request body failed ASP.NET Web API model validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblem" } } } }, "CannotDetermineIpAddress": { "description": "The web tier could not determine the caller IP address.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyStatusMessage" } } } } } }, "x-document-status": { "phase": "Response schema pass", "implementedPublicOperations": 90, "responseSchemasComplete": true, "permissionRequirementsComplete": false, "responseSchemaSources": [ "SymphonieAjax/API/Controllers", "ServiceInterfaces/RestApi.cs", "ServiceLibrary/RestApi.cs", "ServiceLibrary/Documents.cs", "ServiceLibrary/Mailings.cs", "ServiceLibrary/Members.cs", "ServiceLibrary/Workflow.cs" ] } }