![](\"https://assets.postman.com/postman-docs/accessing-saved-examples.jpg\")
The Swift Digital Suite REST API v3 is designed following REST principles. It utilises predictable, resource-oriented URLs, accepts form-encoded request bodies, and returns responses encoded in JSON format. The API also adheres to standard HTTP response codes, authentication mechanisms, and HTTP verbs.
\nAuthentication is handled using OAuth 2.0. To access the API, you need to obtain an access token. This token can be generated by your administrator on the Swift Digital Suite platform. Once generated, this token can be used to authenticate API requests.
\nTo get started with the Swift Digital Suite REST API v3, just click the \"Run in Postman\" button above. Postman is a free tool that helps developers test and debug API requests, and it's where you'll find all the details in this documentation. You can easily access every endpoint mentioned here by importing our collection into the Postman app. Then, simply choose from the examples in the dropdown menu at the top right of the builder interface.
\nThe simplest method to begin utilising the documentation is by clicking the \"Run in Postman\" button provided above.
\n\nIt is a free tool that assists developers in executing and debugging API requests and serves as the definitive source for this documentation. Each endpoint documented here is immediately accessible by running our Postman collection. Import the collection directly into the Postman app and access all saved examples from the \"Examples\" dropdown located in the upper right corner of the builder.
\n
Utilise the Recommended Endpoint Naming Conventions
\nUse the Appropriate HTTP Method
\nConsider rate limits when calling the REST API v3. The default is 600 requests/minute.
\nReview the appropriate HTTP response code returned from the API.
\nhttps://v3.api.swiftdigital.com.au/\n\nhttps://v3.api.swiftdigital.com.au/auth/token\n\nTo facilitate OAuth2 authentication and token generation for the Swift Digital Suite REST API v3, users can follow the steps outlined below. Here's a detailed guide on how users can work with our API to generate access tokens and refresh tokens:
\nThe administrator from your Swift Digital Suite account needs to go to Administration > Integrations and see if the REST API v3 can be accessed.
\nIf the REST API v3 is not visible, please reach out to your account manager and to api@swiftdigital.com.au.
\nThe administrator from your Swift Digital Suite account needs to add an OAuth 2.0 API Client.
\nOAuth 2.0 API client scopes must be selected by the administrator to grant permissions to your application.
\nThe client secret is only given once, and it will be hidden after adding an OAuth2 API Client. Make sure to copy and save the client secret, as it will be used to get access tokens.
\nThe t3 account ID is given after adding an OAuth 2.0 API Client.
\nUsing the Client ID, Client Secret, and T3 Account ID, an access token and a refresh token will be generated by making a POST request to the API's token endpoint.
\nThe POST request will include parameters such as client ID, client secret, and t3 account ID.
\nThe Swift Digital Suite API token endpoint will validate the details and issue an access token and a refresh token in the response.
\nWhen the access token expires, users' applications can use the refresh token to obtain a new access token without requiring the user to re-authenticate.
\nThe users of the application will make a POST request to the Swift Digital Suite REST API v3 token endpoint with parameters including client ID, client secret, refresh token, and grant type (refresh_token).
\nThe Swift Digital Suite REST API v3 token endpoint will validate the refresh token and issue a new access token in the response.
\nBy following these steps, users of our API will be able to authenticate with the Swift Digital Suite API REST v3, obtain access tokens, refresh tokens, and make authorised requests to our API.
\n\n\n\n
{\n \"grant_type\": \"password\",\n \"client_id\": \"Client ID\",\n \"client_secret\": \"Client Secret\",\n \"t3acctid\": \"T3 Account ID\"\n}\n\n{\n \"access_token\": \"dfg098ikdgf098ikdfg089ikdfg-90odfg-09oldgf\",\n \"expires_in\": 2419200,\n \"token_type\": \"Bearer\",\n \"scope\": \"scope_contact_read:on,scope_contact_write:on\",\n \"refresh_token\": \"b94Idfp8i054-09fd-0kdf88898fdnnid0995\"\n}\n\n\n\n\n
{\n \"grant_type\": \"refresh_token\",\n \"client_id\": \"Client ID\",\n \"client_secret\": \"Client Secret\",\n \"refresh_token\": \"Refresh Token\"\n}\n\n{\n \"access_token\": \"dfgkhndg987yuhnd0-dfo87yuhndf9o8yuhn-898erkjh\",\n \"expires_in\": 2419200,\n \"token_type\": \"Bearer\",\n \"scope\": \"scope_contact_read:on,scope_contact_write:on\",\n \"refresh_token\": \"b9987dfugjn9d08-09dfiuyh-0kdfg098349dfg9g5\"\n}\n\nSwift Digital Suite REST API v3 uses conventional HTTP response codes to indicate the success or failure of an API request. In general, Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was missing, etc.). Codes in the 5xx range indicate an error with the Swift Digital Suite API servers.
Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported.
HTTP Status Code Summary:
\nAll top-level API resources have support for bulk fetches through “list” API methods.
\nFor example, you can list contacts, mail groups, folders, events, etc.
\nIt offers an easy-to-use interface for accessing paginated data.
\nThese list API methods share a common structure and accept the following parameters:
\nfrom_date is the start date to select items within a date range.
1735700971)to_date is the end date to select items within a date range.
1764558571)After 1st request, if has_more is true then you must use the next_data to send subsequent requests for data.
{\n \"has_more\": true,\n \"next_data\": \"fgdkiujh4509ujndfg098i45nmsd098imw098iumewr90_890734u5nsduhbn_34897yuhn_23897sdnujlfg90m4_rd-34-df8n_-897nsdf_ewoup8ikwmer\",\n \"total\": 45,\n \"contact_ids\": [\n \"zzzzxx7593efr7110010\",\n \"zzzzxx7593efr7110011\"\n ]\n}\n\nWe have applied rate limits to ensure a smooth and reliable experience with the Swift Digital Suite REST API v3. The default is 600 requests/minute.
\nViolation of the above-mentioned rate limits may impose a temporary ban on the IP/Domain. After the ban is lifted, the client can resume calling the API again.
\nThe ban on the IP/Domain will return the following information:
\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Error Code","slug":"error-code"},{"content":"Pagination","slug":"pagination"},{"content":"Rate Limiting","slug":"rate-limiting"}],"owner":"848661","collectionId":"3b902962-097b-4ae4-9c95-f9cb63c78c29","publishedId":"2sA35G42ms","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"808080","highlight":"6CB8E0"},"publishDate":"2025-09-08T00:46:03.000Z"},"item":[{"name":"Quick Start Guide","item":[],"id":"806e0f5d-03a6-4df9-93b6-544ef5d95bfc","description":"HTTP Code: 429
\n
Message: Too Many Requests
Description: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
This guide will walk you through the basic steps of connecting to and using the Swift Digital Suite API v3 in PHP.
\nPHP 7.0 or higher
\ncURL extension enabled
\nClient ID, Client Secret, and T3Account ID for the Swift Digital Suite API v3
\nFirst, make sure your environment is properly set up. Create a new PHP file (e.g., swiftdigital-api.php) and ensure that cURL is enabled in your PHP installation.
Replace CLIENT_ID, CLIENT_SECRET, and T3ACCTID with your actual Swift Digital Suite API details.
\n$clientIDKey = 'CLIENT_ID'; // YOUR API CLIENT ID\n$clientIDSecret = 'CLIENT_SECRET'; // YOUR API CLIENT SECRET\n$t3acctid = 'T3ACCTID'; // YOUR API T3ACCTID\n$api_url = 'https://v3.api.swiftdigital.com.au/request';\n$token_url = 'https://v3.api.swiftdigital.com.au/auth/token';\n$access_token = false;\n$refresh_token = false;\n\nCreate a reusable function to handle API requests.
\nfunction callSwiftDigitalSuiteAPI($endpoint, $action_url, $method = 'GET', $data = null) {\n global $access_token;\n $ch = curl_init();\n $url = $action_url. $endpoint;\n $headers = [\n 'Content-Type: application/json'\n ];\n if($access_token){\n $headers = [\n 'Content-Type: application/json',\n 'Authorization: Bearer ' . $access_token\n ];\n }\n curl_setopt($ch, CURLOPT_URL, $url);\n curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);\n curl_setopt($ch, CURLOPT_CUSTOMREQUEST , $method);\n if ($method == 'POST') {\n curl_setopt($ch, CURLOPT_POST, true);\n curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));\n }\n $response = curl_exec($ch);\n if (curl_errno($ch)) {\n throw new Exception('Error: ' . curl_error($ch));\n }\n $httpcode = curl_getinfo($ch, CURLINFO_HTTP_CODE);\n echo \"HTTP response code is \".$httpcode.\"\\r\\n\";\n curl_close($ch);\n return json_decode($response, true);\n}\n\nGenerate the access token using Client ID, Client Secret, and T3 Account ID. Please note that you need to pass grant_type password
echo \"Step 4: Get Access Token with Client ID, Client Secret, and T3AcctID\\r\\n\";\n$data = array();\n$data['grant_type'] = 'password';\n$data['client_id'] = $clientIDKey;\n$data['client_secret'] = $clientIDSecret;\n$data['t3acctid'] = $t3acctid;\n$response = callSwiftDigitalSuiteAPI('', $token_url, 'POST', $data);\necho \"Request:\\r\\n\";\nprint_r($data);\necho \"Response:\\r\\n\";\nprint_r($response);\nif($response['access_token']){\n $access_token = $response['access_token'];\n}\nif($response['refresh_token']){\n $refresh_token = $response['refresh_token'];\n}\n\nStep 4: Get Access Token with Client ID, Client Secret, and T3AcctID\nHTTP response code is 200\nRequest:\nArray\n(\n [grant_type] => password\n [client_id] => Client-XXXXXXXXXX\n [client_secret] => fexxxxxxxxxxxxxxxxxxxxxxxxxxMa\n [t3acctid] => zzzzXXXXXXXXXXXXX28\n)\nResponse:\nArray\n(\n [access_token] => 5cfcc6f5b9e490587ae7ff92595a9836a0785594\n [expires_in] => 2419200\n [token_type] => Bearer\n [scope] => scope_contact_read:on,scope_contact_write:on,scope_mailgroup_read:on,scope_mailgroup_write:on,scope_import_write:on\n [refresh_token] => eb9eXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX0d28\n)\n\nGenerate the access token using refresh_token. Please note that you need to pass grant_type refresh_token
echo \"Step 5: Get Access Token with Refresh Token (Optional)\\r\\n\";\n$data = array();\n$data['grant_type'] = 'refresh_token'; // Set grant_type to refresh_token\n$data['client_id'] = $clientIDKey;\n$data['client_secret'] = $clientIDSecret;\n$data['refresh_token'] = $refresh_token;\n// Set $access_token to false. This is make sure callSwiftDigitalSuiteAPI don't pass access_token in the request\n$access_token = false; \n$response = callSwiftDigitalSuiteAPI('', $token_url, 'POST', $data);\necho \"Request:\\r\\n\";\nprint_r($data);\necho \"Response:\\r\\n\";\nprint_r($response);\nif($response['access_token']){\n $access_token = $response['access_token'];\n}\nif($response['refresh_token']){\n $refresh_token = $response['refresh_token'];\n}\n\nStep 5: Get Access Token with Refresh Token (Optional)\nHTTP response code is 200\nRequest:\nArray\n(\n [grant_type] => refresh_token\n [client_id] => Client-XXXXXXXXXX\n [client_secret] => fexxxxxxxxxxxxxxxxxxxxxxxxxxMa\n [refresh_token] => eb9eXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX0d28\n)\nResponse:\nArray\n(\n [access_token] => 30b78XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXc44f6859ef3c\n [expires_in] => 2419200\n [token_type] => Bearer\n [scope] => scope_contact_read:on,scope_contact_write:on\n [refresh_token] => a4b1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXdc7e6\n)\n\nLet's make a simple GET request to test the connection. For example, fetching a list of mail groups:
\necho \"Step 6: Test the Connection by getting list of Mailgroups\\r\\n\";\n$response = callSwiftDigitalAPI('/mailhouse/mailgroup/list', $api_url, 'GET', false);\necho \"Request:\\r\\n\";\nprint_r(array());\necho \"Response:\\r\\n\";\nprint_r($response);\n\nStep 6: Test the Connection\nHTTP response code is 200\nRequest:\nArray\n(\n)\nResponse:\nArray\n(\n [has_more] => 1\n [next_data] => KikIYghVYJ5lBYze0SHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXHDigMEYImwHQ==\n [total] => 1994\n [data] => Array\n (\n [0] => Array\n (\n [group_id] => zzzzXXXXXXXXXXXXXX73\n [group_name] => VIP Group 1\n [is_test] => N\n [folder_id] => 1234\n [folder_name] => VIP\n [modified_on] => 1703758362\n )\n [1] => Array\n (\n [group_id] => zzzzXXXXXXXXXXXXXX74\n [group_name] => VIP Group 1\n [is_test] => N\n [folder_id] => 1234\n [folder_name] => VIP\n [modified_on] => 1679527581\n )\n [2] => Array\n (\n [group_id] => zzzzXXXXXXXXXXXXXX75\n [group_name] => VIP Test\n [is_test] => Y\n [folder_id] => 1234\n [folder_name] => VIP\n [modified_on] => 1678762051\n )\n <strong class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' > ... ... ...</b>\n [19] => Array\n (\n [group_id] => zzzzXXXXXXXXXXXXXX79\n [group_name] => VIP Other\n [is_test] => N\n [folder_id] => 1234\n [folder_name] => VIP\n [modified_on] => 1683527333\n )\n )\n)\n\nNow, let's create a new contact. Replace the sample data with your actual data. You can add the newly created contact to an existing mail group by using the mail group's unique identifier (group_id).
\necho \"Step 7: Create a New Contact and Add to a Mail Group\\r\\n\";\n$data = array();\n$data['fields']['email'] = 'john.doe@swiftdigital.com.au'; \n$data['fields']['first_name'] = 'John'; \n$data['fields']['last_name'] = 'Doe'; \n$data['fields']['mobile'] = '0412345678'; \n$data['groups'][]['groupid'] = 'XXXXXXXXX'; // Any mailgroup id from your previous call \n$response = callSwiftDigitalSuiteAPI('/mailhouse/contact/create', $api_url, 'POST', $data);\necho \"Request:\\r\\n\";\nprint_r($data);\necho \"Response:\\r\\n\";\nprint_r($response);\n\nStep 7: Create a New Contact and Add to a Mail group\nHTTP response code is 200\nRequest:\nArray\n(\n [fields] => Array\n (\n [email] => john.doe@swiftdigital.com.au\n [first_name] => John\n [last_name] => Doe\n [mobile] => 0412345678\n )\n [groups] => Array\n (\n [0] => Array\n (\n [groupid] => zzzzXXXXXXXXXXXXXX10\n )\n )\n)\nResponse:\nArray\n(\n [data] => zzzzXXXXXXXXXXXXXX50\n)\n\nNow we can try to delete the newly created contact. Please review the HTTP response code after the delete.
\n$contact_id = $response['contact_id'];\necho \"Step 8: Delete the contact\\r\\n\";\n$data = array();\n$response = callSwiftDigitalSuiteAPI('/mailhouse/contact/delete?contact_id='.$contact_id, $api_url, 'DELETE', false);\necho \"Request:\\r\\n\";\nprint_r($data);\necho \"Response:\\r\\n\";\nprint_r($response);\n\nStep 8: Delete the Contact\nHTTP response code is 204\nRequest:\nArray\n(\n)\nResponse:\n\nMake sure to handle the API responses properly. The Swift Digital Suite API returns JSON, which you can easily decode and use in your PHP application.
\n$data = array();\n$response = callSwiftDigitalSuiteAPI('/mailhouse/contact/read?contact_id='.$contact_id, $api_url, 'GET', false);\necho \"Request:\\r\\n\";\nprint_r($data);\necho \"Response:\\r\\n\";\nif (isset($response['error'])) {\n echo 'API Error: ' . $response['error'].\"\\r\\n\";\n} else {\n // Process the successful response\n print_r($response);\n}\n\nStep 9: Read the Deleted Contact (Error testing)\nHTTP response code is 400\nRequest:\nArray\n(\n)\nResponse:\nAPI Error: The `contact_id` does not exist.\n\nYou’ve now set up a basic PHP script to interact with the Swift Digital Suite API v3. This guide covered connecting to the API, making a simple GET request, creating a new contact, and adding that contact to a Mailgroup.
\nFrom here, you can expand on this foundation by implementing additional API endpoints and building more complex workflows according to your needs.
\nThe full version of the code is attached below
\n$clientIDKey = 'CLIENT_ID'; // YOUR API CLIENT ID\n$clientIDSecret = 'CLIENT_SECRET'; // YOUR API CLIENT SECRET\n$t3acctid = 'T3ACCTID'; // YOUR API T3ACCTID\n$api_url = 'https://v3.api.swiftdigital.com.au/request';\n$token_url = 'https://v3.api.swiftdigital.com.au/auth/token';\n$access_token = false;\n$refresh_token = false;\nfunction callSwiftDigitalSuiteAPI($endpoint, $action_url, $method = 'GET', $data = null) {\n global $access_token;\n $ch = curl_init();\n $url = $action_url. $endpoint;\n $headers = [\n 'Content-Type: application/json'\n ];\n if($access_token){\n $headers = [\n 'Content-Type: application/json',\n 'Authorization: Bearer ' . $access_token\n ];\n }\n curl_setopt($ch, CURLOPT_URL, $url);\n curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);\n curl_setopt($ch, CURLOPT_CUSTOMREQUEST , $method);\n if ($method == 'POST') {\n curl_setopt($ch, CURLOPT_POST, true);\n curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));\n }\n $response = curl_exec($ch);\n if (curl_errno($ch)) {\n throw new Exception('Error: ' . curl_error($ch));\n }\n $httpcode = curl_getinfo($ch, CURLINFO_HTTP_CODE);\n echo \"HTTP response code is \".$httpcode.\"\\r\\n\";\n curl_close($ch);\n return json_decode($response, true);\n}\necho \"Step 4: Get Access Token with Client ID, Client Secret, and T3AcctID\\r\\n\";\n$data = array();\n$data['grant_type'] = 'password';\n$data['client_id'] = $clientIDKey;\n$data['client_secret'] = $clientIDSecret;\n$data['t3acctid'] = $t3acctid;\n$response = callSwiftDigitalSuiteAPI('', $token_url, 'POST', $data);\necho \"Request:\\r\\n\";\nprint_r($data);\necho \"Response:\\r\\n\";\nprint_r($response);\nif($response['access_token']){\n $access_token = $response['access_token'];\n}\nif($response['refresh_token']){\n $refresh_token = $response['refresh_token'];\n}\necho \"Step 5: Get Access Token with Refresh Token (Optional)\\r\\n\";\n$data = array();\n$data['grant_type'] = 'refresh_token'; // Set grant_type to refresh_token\n$data['client_id'] = $clientIDKey;\n$data['client_secret'] = $clientIDSecret;\n$data['refresh_token'] = $refresh_token;\n// Set $access_token to false. This is make sure callSwiftDigitalAPI don't pass access_token in the request\n$access_token = false; \n$response = callSwiftDigitalSuiteAPI('', $token_url, 'POST', $data);\necho \"Request:\\r\\n\";\nprint_r($data);\necho \"Response:\\r\\n\";\nprint_r($response);\nif($response['access_token']){\n $access_token = $response['access_token'];\n}\nif($response['refresh_token']){\n $refresh_token = $response['refresh_token'];\n}\necho \"Step 6: Test the Connection\\r\\n\";\n$response = callSwiftDigitalSuiteAPI('/mailhouse/mailgroup/list', $api_url, 'GET', false);\necho \"Request:\\r\\n\";\nprint_r(array());\necho \"Response:\\r\\n\";\nprint_r($response);\necho \"Step 7: Create a New Contact and add to a Mail Group\\r\\n\";\n$data = array();\n$data['fields']['email'] = 'john.doe@swiftdigital.com.au'; \n$data['fields']['first_name'] = 'John'; \n$data['fields']['last_name'] = 'Doe'; \n$data['fields']['mobile'] = '0412345678'; \n$data['groups'][]['groupid'] = 'zzzz59e535a65063c510'; \n$response = callSwiftDigitalSuiteAPI('/mailhouse/contact/create', $api_url, 'POST', $data);\necho \"Request:\\r\\n\";\nprint_r($data);\necho \"Response:\\r\\n\";\nprint_r($response);\n$contact_id = $response['contact_id'];\necho \"Step 8: Delete the Contact\\r\\n\";\n$data = array();\n$response = callSwiftDigitalSuiteAPI('/mailhouse/contact/delete?contact_id='.$contact_id, $api_url, 'DELETE', false);\necho \"Request:\\r\\n\";\nprint_r($data);\necho \"Response:\\r\\n\";\nprint_r($response);\n$data = array();\n$response = callSwiftDigitalSuiteAPI('/mailhouse/contact/read?contact_id='.$contact_id, $api_url, 'GET', false);\necho \"Request:\\r\\n\";\nprint_r($data);\necho \"Response:\\r\\n\";\nif (isset($response['error'])) {\n echo 'API Error: ' . $response['error'].\"\\r\\n\";\n} else {\n // Process the successful response\n print_r($response);\n}\n?>\n\nThe full version of the output is attached below
\nStep 4: Get Access Token with Client ID, Client Secret, and T3AcctID\nHTTP response code is 200\nRequest:\nArray\n(\n [grant_type] => password\n [client_id] => Client-XXXXXXXXXX\n [client_secret] => fexxxxxxxxxxxxxxxxxxxxxxxxxxMa\n [t3acctid] => zzzzXXXXXXXXXXXXX28\n)\nResponse:\nArray\n(\n [access_token] => 5cfcc6f5b9e490587ae7ff92595a9836a0785594\n [expires_in] => 2419200\n [token_type] => Bearer\n [scope] => scope_contact_read:on,scope_contact_write:on,scope_mailgroup_read:on,scope_mailgroup_write:on,scope_import_write:on\n [refresh_token] => eb9eXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX0d28\n)\nStep 5: Get Access Token with Refresh Token (optional)\nHTTP response code is 200\nRequest:\nArray\n(\n [grant_type] => refresh_token\n [client_id] => Client-XXXXXXXXXX\n [client_secret] => fexxxxxxxxxxxxxxxxxxxxxxxxxxMa\n [refresh_token] => eb9eXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX0d28\n)\nResponse:\nArray\n(\n [access_token] => 30b78XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXc44f6859ef3c\n [expires_in] => 2419200\n [token_type] => Bearer\n [scope] => scope_contact_read:on,scope_contact_write:on,scope_mailgroup_read:on,scope_mailgroup_write:on,scope_import_write:on\n [refresh_token] => a4b1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXdc7e6\n)\nStep 6: Test the Connection\nHTTP response code is 200\nRequest:\nArray\n(\n)\nResponse:\nArray\n(\n [has_more] => 1\n [next_data] => KikIYghVYJ5lBYze0SHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXHDigMEYImwHQ==\n [total] => 1994\n [data] => Array\n (\n [0] => Array\n (\n [group_id] => zzzzXXXXXXXXXXXXXX73\n [group_name] => VIP Group 1\n [is_test] => N\n [folder_id] => 1234\n [folder_name] => VIP\n [modified_on] => 1703758362\n )\n [1] => Array\n (\n [group_id] => zzzzXXXXXXXXXXXXXX74\n [group_name] => VIP Group 1\n [is_test] => N\n [folder_id] => 1234\n [folder_name] => VIP\n [modified_on] => 1679527581\n )\n [2] => Array\n (\n [group_id] => zzzzXXXXXXXXXXXXXX75\n [group_name] => VIP Test\n [is_test] => Y\n [folder_id] => 1234\n [folder_name] => VIP\n [modified_on] => 1678762051\n )\n ... ... ...\n [19] => Array\n (\n [group_id] => zzzzXXXXXXXXXXXXXX79\n [group_name] => VIP Other\n [is_test] => N\n [folder_id] => 1234\n [folder_name] => VIP\n [modified_on] => 1683527333\n )\n )\n)\nStep 7: Create a New Contact and Add to a Mail Group\nHTTP response code is 200\nRequest:\nArray\n(\n [fields] => Array\n (\n [email] => john.doe@swiftdigital.com.au\n [first_name] => John\n [last_name] => Doe\n [mobile] => 0412345678\n )\n [groups] => Array\n (\n [0] => Array\n (\n [groupid] => zzzzXXXXXXXXXXXXXX10\n )\n )\n)\nResponse:\nArray\n(\n [data] => zzzzXXXXXXXXXXXXXX50\n)\nStep 8: Delete the contact\nHTTP response code is 204\nRequest:\nArray\n(\n)\nResponse:\nStep 9: Read the Deleted Contact (Error testing)\nHTTP response code is 400\nRequest:\nArray\n(\n)\nResponse:\nAPI Error: The `contact_id` does not exist.\n\nThe authentication token endpoint issues a bearer token for use with the Swif Digital Suite API. All API requests must include a valid token in the Authorization header. Tokens are short-lived and should be refreshed as needed.
To get an access token and a refresh token, you'll need to send a POST request to the token endpoint of the Swift Digital Suite API. You will need to include your client_id, client_secret, and t3acctid in the request.
POST
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe client API credentials are invalid.
\nThe client API credentials are not found in the header or body of the request.
\nThe client API credentials are invalid. Please authenticate using client_secret.
The t3acctid is invalid.
Invalid grant_type, client_id, client_secret, and t3acctid combination.
The grant_type is invalid.
The grant_type \" \" is not supported.
This API endpoint retrieves a list of all the contacts in your account on the Swift Digital Suite platform. The API response also provides you with the total number of contacts in your account, which helps you monitor and report on your contact number effectively.
\nGET
\nThis API endpoint allows you to search through your contacts in the mail house on the Swift Digital Suite platform. The API response will show all the contact_ids that match the specified criteria. It is helpful when finding the contacts that will be added to the mail groups for an effective segmentation of contacts on email campaigns.
\nNote: When doing a pagination request on the API, only the next_data is required.
\nPOST
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of search_field cannot be empty.
Invalid value provided for search_field.
This API endpoint allows you to create a new contact with details such as name, email, phone number, address, and custom fields in the Swift Digital Suite platform. The contact's unique identifier (contact_id) is given after successful completion. This is useful when syncing or pushing new contacts from a CRM to the Swift Digital Suite platform.
\nPOST
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of fields cannot be empty.
Unable to create. Please provide either an email or a mobile.
Unable to create. Contact with the same email already exists.
Unable to create. Contact with the same mobile already exists.
Unable to create. Contact with the same first_name, last_name, email, and external_id already exists.
Unable to create. Contact with the same first_name, last_name, mobile, and external_id already exists.
The value of external_id cannot be empty.
'email' is not a valid email address.
The mobile is too short. It should have 10 characters or more.
Invalid value provided for 'date field' . The date must be in the format dd/mm/yyyy.
The value of 'single choice field' should either be 'single choice field option 1' or 'single choice field option 2'.
Invalid value provided for country. The country must be in code format like AU.
This API endpoint allows you to retrieve the contact information from the mail house module of the Swift Digital Suite platform using the provided contact's unique identifier (contact_id) and returns the contact data.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of contact_id cannot be empty.
Invalid value provided for contact_id.
The contact_id does not exist.
(Required) The unique ID associated with the contact.
\n","type":"text/plain"},"key":"contact_id","value":"This API endpoint allows you to update the details of an existing contact in the Swift Digital Suite platform. You can modify various fields such as name, email, mobile, and custom attributes. The contact's unique identifier (contact_id) is required to perform the update. The request payload should include the fields that need to be updated. The API returns the updated contact details upon successful completion.
\nPOST
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of fields cannot be empty.
Unable to update. Please provide either an email or a mobile.
Unable to update. Contact with the same email already exists.
Unable to update. Contact with the same mobile already exists.
Unable to update. Contact with the same first_name, last_name, email, and external_id already exists.
Unable to update. Contact with the same first_name, last_name, mobile, and external_id already exists.
The value of external_id cannot be empty.
'email' is not a valid email address.
The mobile is too short. It should have 10 characters or more.
Invalid value provided for 'date field' . The date must be in the format dd/mm/yyyy.
The value of 'single choice field' should either be 'single choice field option 1' or 'single choice field option 2'.
Invalid value provided for country. The country must be in code format like AU.
This API endpoint allows you to delete an existing contact from the Swift Digital Suite platform. The contact's unique identifier (contact_id) is required to perform the deletion. Once deleted, the contact cannot be recovered. Please note that 204 No Content is the API response code for successful deletion.
Warning: Deleting a contact is irreversible and will permanently remove the contact from the system. Use this function with caution to avoid unintended data loss.
\nDELETE
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of contact_id cannot be empty.
Invalid value provided for contact_id.
The contact_id does not exist.
Unable to delete. The contact_id is unsubscribed. Please resubscribe thecontact_id to delete.
(Required) The unique ID associated with the contact
\n","type":"text/plain"},"key":"contact_id","value":"This API endpoint allows you to add a contact to one or more mail groups within the Swift Digital Suite platform. By specifying the mail groups' unique identifier (group_ids), you can assign the contact to relevant mail groups, helping to organise and manage your contacts effectively. The contact's unique identifier (contact_id) is required, along with the list of group_ids to which the contact should be added.
\nPATCH
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of contact_id cannot be empty.
Invalid value provided for contact_id.
The contact_id does not exist.
The value of group_ids cannot be empty.
If the body contains group_ids where the contact_id is both a member and not yet a member, the contact_id will only be added to the group_ids where it is not yet a member. The API response will have a status code of 200 OK and an error message for group_ids where the contact is already a member of.
\ncontact_id is already a member of the group_ids.If the body contains both valid and invalid group_ids, the contact_id will only be added to the valid group_ids. The API response will have a status code of 200 OK and an error message for invalid group_ids.
\ngroup_ids contain invalid values. The contact_id cannot be added to the group_ids.This API endpoint allows you to retrieve a list of mail groups associated with a specific contact on the Swift Digital Suite platform. The contact's unique identifier (contact_id) is required, and the API response includes the list of unique identifiers associated with mail groups (group_ids).
\nNote: When doing a pagination request on the API, only the next_data is required.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of contact_id cannot be empty.
Invalid value provided for contact_id.
The contact_id does not exist.
(Required) The unique ID associated with the contact.
\n","type":"text/plain"},"key":"contact_id","value":"(Optional) Allows you to retrieve the next batch of data from your previous API call.
\n","type":"text/plain"},"key":"next_data","value":"This API endpoint allows you to remove a contact from one or more groups in the Swift Digital Suite platform. By specifying the mail groups' unique identifier (group_ids), you can disassociate the contact from those mail groups. The contact's unique identifier (contact_id) is required, along with the list of group_ids to be removed.
\nPATCH
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of contact_id cannot be empty.
Invalid value provided for contact_id.
The contact_id does not exist.
The value of group_ids cannot be empty.
If the body contains group_ids where the contact_id is both a member and not yet a member, the contact_id will only be removed from the group_ids it is a member. The API response will have a status code of 200 OK and an error message for group_ids where the contact is not a member.
\ncontact_id is not a member of the group_ids.If the body contains both valid and invalid group_ids, the contact_id will only be removed to the valid group_ids. The API response will have a status code of 200 OK and an error message for invalid group_ids.
\ngroup_ids contain invalid values. The contact_id cannot be removed to the group_ids.This API endpoint allows you to unsubscribe a contact from receiving email communications through the Swift Digital Suite platform. The contact's unique identifier (contact_id) is required to perform the email unsubscription. Once unsubscribed for email, the contact will no longer receive any email campaigns or related communications from your organisation.
\nPATCH
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of contact_id cannot be empty.
Invalid value provided for contact_id.
The contact_id does not exist.
The contact_id is already unsubscribed from email.
(Required) The unique ID associated with the contact.
\n","type":"text/plain"},"key":"contact_id","value":"This API endpoint allows you to unsubscribe a contact from receiving SMS communications through the Swift Digital Suite platform. The contact's unique identifier (contact_id) is required to perform the SMS unsubscription. Once unsubscribed for SMS, the contact will no longer receive any SMS campaigns or related communications from your organisation.
\nPATCH
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of contact_id cannot be empty.
Invalid value provided for contact_id.
The contact_id does not exist.
The contact_id is already unsubscribed from SMS.
(Required) The unique ID associated with the contact.
\n","type":"text/plain"},"key":"contact_id","value":"This API endpoint allows you to resubscribe a contact to receive email communications through the Swift Digital Suite platform. The contact's unique identifier (contact_id) is required to perform the email resubscription. Once resubscribed for email, the contact will be reactivated to receive email campaigns and related communications from your organisation.
\nPATCH
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of contact_id cannot be empty.
Invalid value provided for contact_id.
The contact_id does not exist.
The contact_id is already subscribed to email.
(Required) The unique ID associated with the contact.
\n","type":"text/plain"},"key":"contact_id","value":"This API endpoint allows you to resubscribe a contact to receive SMS communications through the Swift Digital Suite platform. The contact's unique identifier (contact_id) is required to perform the SMS resubscription. Once resubscribed for SMS, the contact will be reactivated to receive SMS campaigns and related communications from your organisation.
\nPATCH
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of contact_id cannot be empty.
Invalid value provided for contact_id.
The contact_id does not exist.
The contact_id is already subscribed to SMS.
(Required) The unique ID associated with the contact.
\n","type":"text/plain"},"key":"contact_id","value":"This API endpoint allows you to unbounce a contact to receive email communications through the Swift Digital Suite platform. The contact's unique identifier (contact_id) is required to perform the unbounce. Once unbounced, the contact will be reactivated to receive email campaigns and related communications from your organisation.
\nPATCH
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of contact_id cannot be empty.
Invalid value provided for contact_id.
The contact_id does not exist.
The contact_id is already unbounced.
(Required) The unique ID associated with the contact.
\n","type":"text/plain"},"key":"contact_id","value":"This API endpoint allows you to bounce a contact from receiving email communications through the Swift Digital Suite platform. The contact's unique identifier (contact_id) is required to perform the bounce. Once bounced, the contact will no longer receive any email campaigns and related communications from your organisation.
\nPATCH
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of contact_id cannot be empty.
Invalid value provided for contact_id.
The contact_id does not exist.
The contact_id is already bounced.
(Required) The unique ID associated with the contact.
\n","type":"text/plain"},"key":"contact_id","value":"This API endpoint returns whether the contact has been created, modified, or deleted within a given date and time range. Use this function to check if there have been any changes to the contact's first name, last name, bounce status, unsubscribe status, or any other standard or custom field during a specified period of time.
\nNote: When doing a pagination request on the API, only the next_data is required.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of contact_id cannot be empty.
Invalid value provided for contact_id.
The contact_id does not exist.
This value should be of epoch unix timestamp.
\nThe value of order_by should be either asc or desc.
(Required) The unique ID associated with the contact.
\n","type":"text/plain"},"key":"contact_id","value":"(Optional) The date when the log starts. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"from_date","value":"(Optional) The date when the log ends. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"to_date","value":"(Optional) ASC, DESC (Default ASC)
\n","type":"text/plain"},"key":"order_by","value":"ASC"},{"description":{"content":"(Optional) Allows you to retrieve the next batch of data from your previous API call.
\n","type":"text/plain"},"key":"next_data","value":"This API endpoint retrieves the Profile 360 log for a specific contact, providing a view of their activities within the Swift Digital Suite platform. The data returned includes interactions, campaign history, and other relevant activities associated with the contact.
\nNote: When doing a pagination request on the API, only the next_data is required.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of contact_id cannot be empty.
Invalid value provided for contact_id.
The contact_id does not exist.
This value should be of epoch unix timestamp.
\nThe value of order_by should be either asc or desc.
(Required) The unique ID associated with the contact.
\n","type":"text/plain"},"key":"contact_id","value":"(Optional) The date when the log starts. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"from_date","value":"(Optional) The date when the log ends. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"to_date","value":"(Optional) ASC, DESC (Default ASC)
\n","type":"text/plain"},"key":"order_by","value":"ASC"},{"description":{"content":"(Optional) Allows you to retrieve the next batch of data from your previous API call.
\n","type":"text/plain"},"key":"next_data","value":"This API endpoint returns the Profile 360 records for a contact, providing a comprehensive view of their activities within the Swift Digital Suite platform. The data returned includes interactions, campaign history (opened, clicked, sent, forwarded), event history, survey history, and other relevant activities associated with the contact.
\nNote: When doing a pagination request on the API, only the next_data is required.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of contact_id cannot be empty.
Invalid value provided for contact_id.
The contact_id does not exist.
This value should be of epoch unix timestamp.
\nThe value of order_by should be either asc or desc.
(Required) The unique ID associated with the contact.
\n","type":"text/plain"},"key":"contact_id","value":"(Optional) The date when the activities start. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"from_date","value":"(Optional) The date when the activities end. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"to_date","value":"(Optional) ASC, DESC (Default ASC)
\n","type":"text/plain"},"key":"order_by","value":"ASC"},{"description":{"content":"(Optional) Allows you to retrieve the next batch of data from your previous API call.
\n","type":"text/plain"},"key":"next_data","value":"This API endpoint returns the membership activities for a contact within a specified date and time range. It logs actions such as adding or removing the contact from any list, along with details like the action performed, contact_ID, and group_ID. Use this function to track subscription changes or update your contact's membership status effectively.
\nNote: When doing a pagination request on the API, only the next_data is required.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of contact_id cannot be empty.
Invalid value provided for contact_id.
The contact_id does not exist.
This value should be of epoch unix timestamp.
\nThe value of order_by should be either asc or desc.
(Required) The unique ID associated with the contact.
\n","type":"text/plain"},"key":"contact_id","value":"(Optional) The date when the log starts. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"from_date","value":"(Optional) The date when the log ends. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"to_date","value":"(Optional) ASC, DESC (Default ASC)
\n","type":"text/plain"},"key":"order_by","value":"(Optional) Allows you to retrieve the next batch of data from your previous API call.
\n","type":"text/plain"},"key":"next_data","value":"This API endpoint retrieves all standard and custom fields defined in the mail house on the Swift Digital Suite platform. Standard fields include pre-defined contact attributes such as title, first name, last name, email address, mobile, and country. Custom fields are user-defined and can be tailored to capture specific data relevant to your campaigns or contact management needs. This endpoint is useful for understanding the data structure of your mail house and for ensuring that your contact records are consistently formatted.
\n","auth":{"type":"oauth2","oauth2":{},"isInherited":true,"source":{"_postman_id":"3b902962-097b-4ae4-9c95-f9cb63c78c29","id":"3b902962-097b-4ae4-9c95-f9cb63c78c29","name":"Swift Digital Suite REST API v3","type":"collection"}},"urlObject":{"path":["request","mailhouse","contact","fields"],"host":["https://v3.api.swiftdigital.com.au"],"query":[],"variable":[]}},"response":[{"id":"74543eff-c990-4214-aaf1-8b6503476708","name":"SUCCESS","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://v3.api.swiftdigital.com.au/request/mailhouse/contact/fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"field_id\": \"TITLE\",\n \"field_name\": \"Title\",\n \"field_type\": \"Text\",\n \"type_code\": \"A\",\n \"merge_field\": \"TITLE\",\n \"max_size\": 30,\n \"options\": \"[N/A]\",\n \"order_number\": \"[N/A]\"\n },\n {\n \"field_id\": \"zzzzxx7593xyu7110010\",\n \"field_name\": \"Position\",\n \"field_type\": \"Text\",\n \"type_code\": \"A\",\n \"merge_field\": \"POSITION\",\n \"max_size\": 250,\n \"options\": \"[N/A]\",\n \"order_number\": \"2\"\n }\n]"}],"_postman_id":"a8506b0a-a5e5-4bc3-933b-095febb9e9d4"}],"id":"10fa259c-ac64-4c6c-b0b5-19f93a7d8ba2","description":"The Swift Digital Suite is a comprehensive platform designed to manage and engage with contacts effectively. A contact in the Swift Digital Suite represents an individual or entity with whom you interact through your digital marketing and communication efforts. Contacts are central to your campaigns, as they are the recipients of your emails, SMS messages, surveys, and other forms of outreach.
\nRich Contact Profiles: Each contact record contains a wealth of information, including standard fields like name, email address, and phone number, as well as custom fields that you define to suit your specific needs (e.g., POSTCODE, DATE_OF_BIRTH).
\nCustom Fields: The Swift Digital Suite platform allows you to create custom fields to capture additional information about your contacts. These fields can be tailored to your business requirements and are identified by unique codes, usually formatted in capital letters and separated by underscores (e.g., MEMBERSHIP_ID, PREFERRED_LANGUAGE)
\nSegmentation and Targeting: Contacts can be segmented based on various criteria, including demographic information, engagement history, and custom field data. This segmentation allows for precise targeting in your campaigns, ensuring that the right message reaches the right audience.
\nSearch and Filtering: The Swift Digital Suite platform provides powerful search and filtering capabilities, enabling you to quickly locate contacts that meet specific criteria. You can perform strict searches for exact matches or fuzzy searches for broader results.
\nEngagement Tracking: The Swift Digital Suite platform tracks all interactions with your contacts, including email opens, link clicks, survey responses, and more. This data helps you understand your contacts' behaviour and tailor your communications accordingly.
\nCompliance and Consent Management: Managing consent and compliance is made easy with the Swift Digital Suite platform. You can track opt-ins, preferences, and other compliance-related data to ensure your communications adhere to relevant regulations.
\nThe API endpoints for contact provide robust functionality for interacting with contacts, allowing developers to automate and manage communication workflows programmatically. Here are some key ways in which contacts can be used:
\nMarketing Campaigns: Leverage contact data to create personalised marketing campaigns that resonate with your audience.
\nEvent Management: Manage event invitations, registrations, and follow-ups by utilising contact information stored in the suite.
\nSurveys and Feedback: Send targeted surveys to specific contact segments to gather valuable feedback.
\nIn summary, contacts in the Swift Digital Suite platform are the foundation of your digital communications. By organising and managing your contacts effectively, you can enhance your outreach efforts and build stronger relationships with your audience.
\n","_postman_id":"10fa259c-ac64-4c6c-b0b5-19f93a7d8ba2","auth":{"type":"oauth2","oauth2":{},"isInherited":true,"source":{"_postman_id":"3b902962-097b-4ae4-9c95-f9cb63c78c29","id":"3b902962-097b-4ae4-9c95-f9cb63c78c29","name":"Swift Digital Suite REST API v3","type":"collection"}}},{"name":"Mail Group","item":[{"name":"mailgroup/list","id":"5b85b8fe-c583-46c7-b836-2090ac04345c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://v3.api.swiftdigital.com.au/request/mailhouse/mailgroup/list?next_data=This API endpoint retrieves a list of all mail groups, including their folder names, the number of contacts on each mail group, and whether each group is designated as a test group or not. This helps you organise all the mail groups in the mail house and differentiate between active and test mail groups within your mail house.
\nGET
\n(Optional) Allows you to retrieve the next batch of data from your previous API call.
\n","type":"text/plain"},"key":"next_data","value":"This API endpoint allows you to create new mail groups within the mail house on the Swift Digital Suite platform. When creating a mail group, you can specify details such as the mail group name, folder location, and whether the mail group is intended for testing purposes. This functionality is crucial for organising contacts into specific segments, enabling targeted communication and efficient management of your email campaigns.
\nPOST
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_name cannot be empty.
The group_name is taken, please get something else.
The group_name only accepts alphabets, spaces, numbers, and special characters - _ () [] , .
The group_name is too long. It should have 250 characters or less.
The value of folder_id cannot be empty.
Invalid value provided for folder_id.
The folder_id does not exist.
This API endpoint allows you to retrieve detailed information about a specific mail group. This includes the mail group name, folder location, whether it’s a test group, and other relevant details. This functionality is useful for reviewing the configuration of a mail group, ensuring it aligns with your campaign and segmentation strategies.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_id cannot be empty.
Invalid value provided for group_id.
The group_id does not exist.
(Required) The unique ID associated with the mail group.
\n","type":"text/plain"},"key":"group_id","value":"This API endpoint allows you to modify the details of an existing mail group in Swift Digital Suite platform. You can update attributes such as the mail group name, folder location, or its designation as a test group. This functionality is essential for keeping your mail groups current and aligned with your evolving segmentation and campaign strategies.
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_id cannot be empty.
Invalid value provided for group_id.
The group_id does not exist.
The value of group_name cannot be empty.
The group_name is taken, please get something else.
The group_name only accepts alphabets, spaces, numbers, and special characters - _ () [] , .
The group_name is too long. It should have 250 characters or less.
The value of folder_id cannot be empty.
Invalid value provided for folder_id.
The folder_id does not exist.
This endpoint allows you to remove an existing mail group from your mail house. Deleting a mail group permanently removes it from the system, which helps you to maintain a clean and organised mail house by eliminating outdated or unnecessary mail groups. The contacts associated with the deleted mail group are still kept in the mail house. Deleting a mail group only deletes the mail group and not the contacts inside it. Please note that 204 No Content is the API response code for successful deletion.
Warning: Deleting a mail group is irreversible and will permanently remove the mail group from the system. Use this function with caution to avoid unintended data loss.
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_id cannot be empty.
Invalid value provided for group_id.
The group_id does not exist.
(Required) The unique ID associated with the mail group.
\n","type":"text/plain"},"key":"group_id","value":"The API endpoint allows you to add one or multiple contacts to an existing mail group in the Swift Digital Suite platform. This feature is useful for efficiently managing your mailing lists, enabling you to bulk add contacts to a specific mail group for targeted email campaigns or communications. It ensures that all specified contacts are successfully subscribed to the selected mail group, helping to keep your lists accurate.
\nPOST
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_id cannot be empty.
Invalid value provided for group_id.
The group_id does not exist.
The value of contact_ids cannot be empty.
If the body contains contact_ids both members and not yet members of the group_id, only the not yet members of the group_id will be added. The API response will have a status code of 200 OK and an error message for contacts not added.
\ncontact_ids are already members of the group_id.If the body contains both valid and invalid contact_ids, only the valid contact_ids will be added. The API response will have a status code of 200 OK and an error message for invalid contact_ids.
\ncontact_ids contain invalid values. The contact_ids cannot be added to the group_id.This API endpoint allows you to retrieve a list of contacts associated with a specific mail group on the Swift Digital Suite platform. The mail group's unique identifier (group_id) is required, and the API response includes the list of unique identifiers associated with contacts (contact_ids).
\nNote: When doing a pagination request on the API, only the next_data is required.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_id cannot be empty.
Invalid value provided for group_id.
The group_id does not exist.
(Required) The unique ID associated with the mail group.
\n","type":"text/plain"},"key":"group_id","value":"(Optional) Allows you to retrieve the next batch of data from your previous API call.
\n","type":"text/plain"},"key":"next_data","value":"This API endpoint allows you to retrieve a list of contacts associated with a specific mail group on the Swift Digital Suite platform. The mail group's unique identifier (group_id) is required, and the API response includes the list of contacts with their corresponding details, such as subscription details, standard and custom fields values.
\nNote: When doing a pagination request on the API, only the next_data is required.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_id cannot be empty.
Invalid value provided for group_id.
The group_id does not exist.
(Required) The unique ID associated with the mail group.
\n","type":"text/plain"},"key":"group_id","value":"(Optional) Allows you to retrieve the next batch of data from your previous API call.
\n","type":"text/plain"},"key":"next_data","value":"The API endpoint allows you to remove one or multiple contacts from an existing mail group in the Swift Digital Suite platform. This feature is useful for efficiently managing your mailing lists, enabling you to bulk remove contacts from a specific mail group for targeted email campaigns or communications. It helps to keep your contact lists clean and accurate.
\nPOST
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_id cannot be empty.
Invalid value provided for group_id.
The group_id does not exist.
The value of contact_ids cannot be empty.
If the body contains contact_ids both members and not yet members of the group_id, only the members of the group_id will be removed. The API response will have a status code of 200 OK and an error message for contacts not removed.
\ncontact_ids are not members of the group_id.If the body contains both valid and invalid contact_ids, only the valid contact_ids will be removed. The API response will have a status code of 200 OK and an error message for invalid contact_ids.
\ncontact_ids contain invalid values. The contact_ids cannot be removed from the group_id.This API endpoint retrieves a list of all folders within your mail house on the Swift Digital Suite platform. This allows you to view and organise your folders in the mail house, helping to maintain a structured and efficient mail house environment for managing your mail groups and contact lists.
\nGET
\n(Optional) Allows you to retrieve the next batch of data from your previous API call.
\n","type":"text/plain"},"key":"next_data","value":"This API endpoint allows you to create new folders within the mail house for organising mail groups on the Swift Digital Suite platform. By creating folders, you can categorise and manage your mail groups more effectively, ensuring a well-structured environment for your contact lists and campaign management.
\nPOST
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of folder_name cannot be empty.
The folder_name is taken, please get something else.
The folder_name only accepts alphabets, spaces, numbers, and special characters - _ () [] , .
The folder_name is too long. It should have 250 characters or less.
This API endpoint allows you to retrieve detailed information about a specific folder within your mail house. This includes the folder name, folder location, and other relevant details. This functionality is useful for organising the mail groups inside your folder, ensuring it aligns with your campaign and segmentation strategies.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of folder_id cannot be empty.
Invalid value provided for folder_id.
The folder_id does not exist.
There are no mail groups inside the folder_id.
(Required) The unique ID associated with the folder.
\n","type":"text/plain"},"key":"folder_id","value":"This API endpoint allows you to update existing folders within the mail house for organising mail groups on the Swift Digital Suite platform. By updating folders, you can categorise and manage your mail groups more effectively, ensuring a well-structured environment for your contact lists and campaign management.
\nPOST
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of folder_name cannot be empty.
The folder_name is taken, please get something else.
The folder_name only accepts alphabets, spaces, numbers, and special characters - _ () [] , .
The folder_name is too long. It should have 250 characters or less.
The folder_name cannot be updated.
The value of folder_id cannot be empty.
Invalid value provided for folder_id.
The folder_id does not exist.
This endpoint API allows you to remove an existing folder from your mailhouse. Deleting a folder permanently removes it from your system, helping you to maintain a clean and organised mail house by eliminating outdated or unnecessary folders. Only folders without any mail groups inside are allowed to be deleted. Please note that 204 No Content is the API response code for successful deletion.
Warning: Deleting a folder is irreversible and will permanently remove the folder from the system. Use this function with caution to avoid unintended data loss.
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of folder_id cannot be empty.
Invalid value provided for folder_id.
The folder_id does not exist.
(Required) The unique ID associated with the folder.
\n","type":"text/plain"},"key":"folder_id","value":"This API endpoint allows you to retrieve a list of contacts who have unsubscribed from email on your account in the Swift Digital Suite platform. This includes a list of contacts' unique identifier (contact_id).
\nNote: When doing a pagination request on the API, only the next_data is required.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_id cannot be empty.
Invalid value provided for group_id.
The group_id does not exist.
(Required) The unique ID associated with the mail group.
\n","type":"text/plain"},"key":"group_id","value":"(Optional) Allows you to retrieve the next batch of data from your previous API call.
\n","type":"text/plain"},"key":"next_data","value":"This API endpoint allows you to retrieve a list of contacts who have unsubscribed from SMS on your account in the Swift Digital Suite platform. This includes a list of contacts' unique identifier (contact_id).
\nNote: When doing a pagination request on the API, only the next_data is required.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_id cannot be empty.
Invalid value provided for group_id.
The group_id does not exist.
(Required) The unique ID associated with the mail group.
\n","type":"text/plain"},"key":"group_id","value":"(Optional) Allows you to retrieve the next batch of data from your previous API call.
\n","type":"text/plain"},"key":"next_data","value":"This endpoint in SwiftDigital allows you to retrieve a list of contacts whos email is bounced in your account. This includes list of contact IDs.
\nNote: When doing a pagination request on the API, only the next_data is required.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_id cannot be empty.
Invalid value provided for group_id.
The group_id does not exist.
(Required) The unique ID associated with the mail group.
\n","type":"text/plain"},"key":"group_id","value":"(Optional) Allows you to retrieve the next batch of data from your previous API call.
\n","type":"text/plain"},"key":"next_data","value":"This API endpoint returns whether the contact inside the mail group has been created, modified, or deleted within a given date and time range. Use this function to check if there have been any changes to the mail group contact's first name, last name, bounce status, unsubscribe status, or any other standard or custom field during a specified period of time.
\nNote: When doing a pagination request on the API, only the next_data is required.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_id cannot be empty.
Invalid value provided for group_id.
The group_id does not exist.
This value should be of epoch unix timestamp.
\nThe value of order_by should be either asc or desc.
(Required) The unique ID associated with the mail group.
\n","type":"text/plain"},"key":"group_id","value":"(Optional) The date when the log starts. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"from_date","value":"(Optional) The date when the log ends. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"to_date","value":"(Optional) ASC, DESC (Default ASC)
\n","type":"text/plain"},"key":"order_by","value":"(Optional) Allows you to retrieve the next batch of data from your previous API call.
\n","type":"text/plain"},"key":"next_data","value":"This API endpoint retrieves the Profile 360 log for the contacts inside the mail group, providing a view of their activities within the Swift Digital Suite platform. The data returned includes interactions, campaign history, and other relevant activities associated with the contacts inside the mail group.
\nNote: When doing a pagination request on the API, only the next_data is required.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_id cannot be empty.
Invalid value provided for group_id.
The group_id does not exist.
This value should be of epoch unix timestamp.
\nThe value of order_by should be either asc or desc.
(Required) The unique ID associated with the mail group.
\n","type":"text/plain"},"key":"group_id","value":"(Optional) The date when the log starts. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"from_date","value":"(Optional) The date when the log ends. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"to_date","value":"(Optional) ASC, DESC (Default ASC)
\n","type":"text/plain"},"key":"order_by","value":"(Optional) Allows you to retrieve the next batch of data from your previous API call.
\n","type":"text/plain"},"key":"next_data","value":"This API endpoint returns the membership activities for the contacts inside the mail group within a specified date and time range. It logs actions such as adding or removing the contact from the mail group, along with details like the action performed, contact_ID, and group_ID. Use this function to track subscription changes or update your mail group effectively.
\nNote: When doing a pagination request on the API, only the next_data is required.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_id cannot be empty.
Invalid value provided for group_id.
The group_id does not exist.
This value should be of epoch unix timestamp.
\nThe value of order_by should be either asc or desc.
(Required) The unique ID associated with the mail group.
\n","type":"text/plain"},"key":"group_id","value":"(Optional) The date when the log starts. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"from_date","value":"(Optional) To date, when the log ends. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"to_date","value":"(Optional) ASC, DESC (Default ASC)
\n","type":"text/plain"},"key":"order_by","value":"(Optional) Allows you to retrieve the next batch of data from your previous API call.
\n","type":"text/plain"},"key":"next_data","value":"A mail group in the Swift Digital Suite platform is a collection of contacts grouped based on specific criteria for targeted communication, such as email campaigns. Mail groups enable users to organise contacts into specific segments, making it easier to send tailored messages to the right audience. By grouping contacts with similar characteristics or behaviours, the mail groups ensure that communication is relevant, increasing engagement and the effectiveness of marketing efforts.
\nAutomation: Automate the process of organising contacts and sending emails, reducing manual work and increasing efficiency.
\nPersonalisation: Tailor your communication to specific groups of contacts, improving relevance and engagement.
\nScalability: Easily manage large volumes of contacts and campaigns through API-driven processes, scaling your marketing efforts without additional manual labour.
\nFlexibility: The API allows for dynamic and real-time updates to Mailgroups, ensuring that your communication strategies can adapt quickly to changing circumstances.
\nThe API endpoints for mail groups provide robust functionality for interacting with mail groups, allowing developers to automate and manage communication workflows programmatically. Here are some key ways in which mail groups can be used:
\nCreating a Mail Group: You can create a new mail group by specifying its name for membership. This allows for dynamic segmentation of contacts based on custom rules, such as subscription status, demographic data, or engagement history. For example, an API call could create a mail group for all contacts who signed up for a webinar, ensuring they receive follow-up emails.
\nAdding Contacts to a Mail Group: The API allows you to add individual contacts or multiple contacts to an existing mail group. This can be done manually or automatically based on actions or attributes, such as form submissions or purchase history. For example, when a new contact signs up on your form, the API can automatically add them to the \"New Subscribers\" mail group, ensuring they receive welcome emails.
\nRemoving Contacts from a Mail Group: You can also remove contacts from a mail group using the API. This is useful for keeping your mail groups up-to-date and ensuring that contacts are only in the relevant mail groups. For example, if a contact opts out of a newsletter, the API can automatically remove them from the \"Newsletter Subscribers\" Mailgroup.
\nManaging Mail Group Membership: The API provides tools for managing mail group memberships, including listing contacts within a mail group, checking if a contact is part of a mail group, and more. For example, an API call could return a list of all contacts in a \"Loyalty Program\" mail group, allowing you to analyse engagement levels and plan future campaigns.
\nIn summary, the Swift Digital Suite mailgroup features, when integrated with the API, provide powerful tools for targeted, automated, and efficient communication management.
\n","_postman_id":"75fbbdf3-155d-410a-9448-4e8a408bd908","auth":{"type":"oauth2","oauth2":{},"isInherited":true,"source":{"_postman_id":"3b902962-097b-4ae4-9c95-f9cb63c78c29","id":"3b902962-097b-4ae4-9c95-f9cb63c78c29","name":"Swift Digital Suite REST API v3","type":"collection"}}},{"name":"Import","item":[{"name":"mailhouse/import/csv","id":"3b02a528-40bd-4297-b683-192a07d4e52a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"group_id\": \"This API endpoint allows you to bulk import contacts into nominated mail groups on the Swift Digital Suite platform by uploading a CSV file. This is designed for high-volume imports such as subscriber lists, migrated contact data, or updating existing records.
\nNote: The import only accepts BASE 64 format.
\nPOST
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_id cannot be empty.
Invalid value provided for group_id.
The group_id does not exist.
The value of file_content cannot be empty.
The value of mappings cannot be empty.
Unable to import. Please provide either an email, mobile , or PUID.
The value of external_id cannot be empty.
The mapping item 'field' does not exist.
This API endpoint allows you to bulk import contacts into nominated mail groups on the Swift Digital Suite platform by uploading a ZIP file. This is designed for high-volume imports such as subscriber lists, migrated contact data, or updating existing records.
\nNote: The import only accepts BASE 64 format.
\nPOST
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of group_id cannot be empty.
Invalid value provided for group_id.
The group_id does not exist.
The value of file_content cannot be empty.
The value of mappings cannot be empty.
Unable to import. Please provide either an email, mobile , or PUID.
The value of external_id cannot be empty.
The mapping item 'field' does not exist.
The import API provides an efficient and automated way to import contact data into a specified mail group within the Swift Digital Suite platform. It is primarily designed to handle bulk data imports for email marketing, newsletter distribution, and other communication purposes. The API supports flexible data input, allowing users to upload contact data in either CSV format or as a compressed ZIP file containing a SINGLE CSV file.
\nThe import APIs only accept data in two file formats:
\nCSV Format: The standard format for importing structured contact data. Each CSV should contain rows representing individual contacts. The format should match the mapping fields' structure to ensure successful import. The CSV file must be converted to Base64 before upload.
ZIP Format: For larger imports, the ZIP format is recommended. This compressed format speeds up file transfer. The ZIP file should contain only one CSV file, and this CSV must adhere to the same formatting rules as standalone CSV uploads. The zip file must be converted to Base64 before upload.
File Upload: After authenticating with the Swift Digital Suite platform via API, the user can upload the Base64 converted CSV or ZIP file containing the contact data to the specified mail group. The API will validate the file to ensure it adheres to the correct format and field structure.
Data Mapping: The API automatically maps the fields from the CSV to the mail group’s contact fields. To ensure proper mapping, the mapping field should include a list of fields corresponding to the CSV format. Each field name should either be a SwiftDigital standard field name or a custom field code. Leave the mapping field blank to skip that particular field. Any mismatches in the mapping may result in import errors.
\nDuplicate Handling: The import APIs are designed to handle duplicate entries based on pre-defined matching rules, such as email address or external ID. If a duplicate is detected, it can be either updated or ignored, based on the configuration of your mail group.
\nError Handling: If there are any issues with the file format or data content (e.g., missing mandatory fields or invalid data types), the import APIs call will respond relevant error. If the import process flags any errors, the report can be found in the import report on the mail house module of the Swift Digital Suite platform.
\nOnce the import process is initiated, you can track its progress and view detailed reports on the mail house module of the Swift Digital Suite. These reports include:
\nOverall Status: Whether the import is completed, in progress, or failed.
\nNumber of Records Processed: A summary of how many records were processed from the uploaded file.
\nAccepted Records: Number of records successfully added to the mailgroup.
\nRejected Records: Detailed error logs explaining why certain records failed to import, such as incorrect formatting, empty rows, invalid mobile numbers, invalid email addresses, or missing mandatory fields.
\nDuplicate Records: Information about how duplicates were handled—whether they were updated, skipped, or resulted in an error.
\nMapping Report: Details about the data field used on the mapping when the import is performed.
\nThe import report enables users to review and correct any issues, ensuring the contact data is accurate and ready for use in the mail group. Additionally, the logs help troubleshoot problems that may arise during large data imports, giving clear insights into what went wrong and how to fix it.
\nAutomated Bulk Imports: Instead of manually adding contacts one by one, this API facilitates bulk imports, saving time and effort for large campaigns.
\nData Integrity: The API provides built-in validation checks, ensuring that your imported data aligns with the structure and requirements of the mail group.
\nScalability: The ability to upload both CSV and ZIP files allows for greater scalability, especially when dealing with large datasets.
\nReal-Time Tracking: Detailed reports and logs available in the Swift Digital Suite platform offer real-time tracking of the import process, giving visibility into both successes and failures.
\nIn summary, this makes the mail house import APIs a powerful tool for organisations that need to manage large-scale email lists and communication databases within the Swift Digital Suite platform.
\n","_postman_id":"0d0cfcee-4a80-4de2-b6c0-d780c2f6b34a","auth":{"type":"oauth2","oauth2":{},"isInherited":true,"source":{"_postman_id":"3b902962-097b-4ae4-9c95-f9cb63c78c29","id":"3b902962-097b-4ae4-9c95-f9cb63c78c29","name":"Swift Digital Suite REST API v3","type":"collection"}}},{"name":"Subscription","item":[{"name":"join","id":"03129599-81b7-49b7-9fb0-005ba9b4d269","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"fields\": { //(Required) The standard and custom field values of the subscriber.\r\n \"title\": \"This API endpoint allows you to add a contact to one or more mail groups on your Swift Digital Suite platform. If the contact does not already exist, they will be created and inserted into the nominated mail groups. If the contact exists, their subscription details and preferences will be updated. The subscription API is helpful for website signup forms (newsletter opt-in).
\nNote: The subscription API only supports double opt-in.
\nPOST
\nWhen a 200 OK response is returned, the body request is 'success' with either of the following messages:
\nThe double opt-in verification email has been sent.
\nThank you for subscribing.
\nYour subscription details are updated.
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of fields cannot be empty.
The value of return_url cannot be empty.
Invalid value provided for return_url.
Invalid value provided for return_url. Only https protocol is allowed.
The double_opt_in_subject is too long. It should have 255 characters or less.
The double_opt_in_from_name is too long. It should have 250 characters or less.
'email' is not a valid email address.
Unable to subscribe. Please provide an email.
The value of external_id cannot be empty.
Invalid value provided for 'date field' . The date must be in the format dd/mm/yyyy.
The value of 'single choice field' should either be 'single choice field option 1' or 'single choice field option 2'.
Invalid value provided for country. The country must be in code format like AU.
An unexpected error occurred. Please try again later.
\nThis API endpoint allows you to update an existing contact standard and custom fields information on the mail house module on your Swift Digital Suite platform. The subscription API is helpful for website signup forms (newsletter opt-in).
\nWorks with the use case that a customer wants to
\nAllow new contacts to subscribe to the form with standard and custom field information, as well as mail group subscriptions.
\nAllow existing contacts to subscribe and update their standard and custom field information, but not their mail group subscriptions.
\nNote: The subscription API only supports double opt-in.
\nPOST
\nWhen a 200 OK response is returned, the body request is 'success' with either of the following messages:
\nThe double opt-in verification email has been sent.
\nThank you for subscribing.
\nYour subscription details are updated.
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of fields cannot be empty.
The value of return_url cannot be empty.
Invalid value provided for return_url.
Invalid value provided for return_url. Only https protocol is allowed.
The double_opt_in_subject is too long. It should have 255 characters or less.
The double_opt_in_from_name is too long. It should have 250 characters or less.
'email' is not a valid email address.
Unable to subscribe. Please provide an email.
The value of external_id cannot be empty.
Invalid value provided for 'date field' . The date must be in the format dd/mm/yyyy.
The value of 'single choice field' should either be 'single choice field option 1' or 'single choice field option 2'.
Invalid value provided for country. The country must be in code format like AU.
An unexpected error occurred. Please try again later.
\nThis API endpoint allows you to update the mail group subscriptions of existing contacts in the mail house module of your Swift Digital Suite platform. The subscription API is helpful for website signup forms (newsletter opt-in).
\nWorks with the use case that a customer wants to
\nAllow new contacts to subscribe to the form with standard and custom field information, as well as mail group subscriptions.
\nAllow existing contacts to subscribe and update their mail group subscriptions, but not their standard and custom field information.
\nNote: The subscription API only supports double opt-in.
\nPOST
\nWhen a 200 OK response is returned, the body request is 'success' with either of the following messages:
\nThe double opt-in verification email has been sent.
\nThank you for subscribing.
\nYour subscription details are updated.
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of fields cannot be empty.
The value of return_url cannot be empty.
Invalid value provided for return_url.
Invalid value provided for return_url. Only https protocol is allowed.
The double_opt_in_subject is too long. It should have 255 characters or less.
The double_opt_in_from_name is too long. It should have 250 characters or less.
'email' is not a valid email address.
Unable to subscribe. Please provide an email.
The value of external_id cannot be empty.
Invalid value provided for 'date field' . The date must be in the format dd/mm/yyyy.
The value of 'single choice field' should either be 'single choice field option 1' or 'single choice field option 2'.
Invalid value provided for country. The country must be in code format like AU.
An unexpected error occurred. Please try again later.
\nThis API endpoint allows you to update existing contact information, including both standard and custom fields, as well as manage mail group subscriptions within the mail house module of your Swift Digital Suite platform. The subscription API is helpful for website signup forms (newsletter opt-in).
\nNote: The subscription API only supports double opt-in.
\nPOST
\nWhen a 200 OK response is returned, the body request is 'success' with either of the following messages:
\nThe double opt-in verification email has been sent.
\nThank you for subscribing.
\nYour subscription details are updated.
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of fields cannot be empty.
The value of return_url cannot be empty.
Invalid value provided for return_url.
Invalid value provided for return_url. Only https protocol is allowed.
The double_opt_in_subject is too long. It should have 255 characters or less.
The double_opt_in_from_name is too long. It should have 250 characters or less.
'email' is not a valid email address.
Unable to subscribe. Please provide an email.
The value of external_id cannot be empty.
Invalid value provided for 'date field' . The date must be in the format dd/mm/yyyy.
The value of 'single choice field' should either be 'single choice field option 1' or 'single choice field option 2'.
Invalid value provided for country. The country must be in code format like AU.
An unexpected error occurred. Please try again later.
\nThe subscription API provides functionality to manage contact subscriptions to mail groups. It is designed to allow developers to integrate Swift Digital Suite mail group subscription management directly into applications, websites, or CRMS.
\nSeamless Subscription Management: Add new or update contact subscriptions to one more mail groups for targeted communications.
\nFlexible Subscribe Data Handling: Stored detailed contact information including name, email, phone, and custom fields.
\nData Integrity: The API is using double opt-in ensuring the contact geniunely wants receive the email communications reducing the chances of accidental signs and minimizing the risk of spam complaints.
\nIntegration: The API supports easy integration into applications or websites with secure data transfer using REST.
\nIn summary, this makes the subscription APIs a powerful tool for organisations that need to buld public facing subscription forms and managing those subscriptions within the Swift Digital Suite platform.
\n","_postman_id":"8c7f9cfc-6f9f-4533-a964-b2cef3e71718","auth":{"type":"oauth2","oauth2":{},"isInherited":true,"source":{"_postman_id":"3b902962-097b-4ae4-9c95-f9cb63c78c29","id":"3b902962-097b-4ae4-9c95-f9cb63c78c29","name":"Swift Digital Suite REST API v3","type":"collection"}}}],"id":"d7d03254-f3a6-4cda-be01-808628697f54","description":"The mail house module of the Swift Digital Suite platform is a powerful tool that handles the management and organisation of contacts and mail groups. It acts as a centralised hub for storing and managing contact information, allowing users to create, update, and organise their contacts efficiently.
\nThe mail house module is designed to manage a vast amount of contact data. It supports custom fields, segmentation, and mailing lists, making it an essential tool for personalised communication. The mail house features enable users to oversee their contact lists, ensuring that email campaigns reach the appropriate audience with the right message.
\nA contact in the mail house refers to an individual or entity stored in your account on the Swift Digital Suite platform. Each contact record may include standard fields such as name, email, and mobile number, along with custom fields that are unique to your account. Contacts serve as the primary data points for communication and can be filtered, segmented, and grouped based on various criteria.
\nFor example, if you have a contact named John Doe, his information—including his title, first name, last name, email, and mobile number—will be stored in the mail house. Additionally, any custom fields specific to your account, such as \"Position\" or \"Company\", can also be attached to John's contact record.
\nA mail group in a mail house is a collection of contacts organised for targeted email campaigns. Mail groups enable users to segment their audience based on specific criteria, such as demographics, behaviour, or custom fields. This approach ensures that communications are relevant and tailored to the recipients.
\nFor instance, if you want to send a promotional email to all contacts in your Swift Digital Suite account who are subscribed to a newsletter, you would first create a mail group that includes those contacts.
\nFor example, you are running a marketing campaign targeting VIP customers.
\nYou need to create a mail group named 'VIP Customers' in the mail house, which includes all contacts who have a custom field value of 'VIP'.
\nJohn Doe, being a VIP, would be part of this mail group.
\nThe mail house module would then manage the distribution of emails specifically to the 'VIP Customers' mail group, and when you initiate the email campaign, all contacts within the mail group, including John Doe, will receive the email.
\nIn summary, the Swift Digital Suite seamlessly integrates contact management and mail groups, enabling precise, personalised, and efficient communication strategies.
\n","_postman_id":"d7d03254-f3a6-4cda-be01-808628697f54","auth":{"type":"oauth2","oauth2":{},"isInherited":true,"source":{"_postman_id":"3b902962-097b-4ae4-9c95-f9cb63c78c29","id":"3b902962-097b-4ae4-9c95-f9cb63c78c29","name":"Swift Digital Suite REST API v3","type":"collection"}}},{"name":"Events Desk","item":[{"name":"Registrant","item":[{"name":"registrant/list","id":"40b3df06-7729-49bf-9560-24b4d7acf6d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://v3.api.swiftdigital.com.au/request/registrant/list?from_date=This API endpoint allows you to retrieve the list of all registrations from an event folder or in a date range on the EventsDesk module of your Swift Digital Suite platform. This includes the booking agent, guest, ticket, payment, CPD points, status, and event details. This helps you organise, manage, and review registrations from your events.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThe value of folder_id cannot be empty.
Invalid value provided for folder_id.
The folder_id does not exist.
This value should be of epoch unix timestamp.
\nThe value of order_by should be either asc or desc.
(Optional) The date when the event registrations start. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"from_date","value":"(Optional) The date when the event registrations end. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"to_date","value":"(Optional) The unique ID associated with the event folder.
\n","type":"text/plain"},"key":"folder_id","value":"This API endpoint enables you to retrieve a list of all emails published within a specified date range on your Swift Digital Suite platform. This includes the email document details and publication report. This helps you organise and review the reporting data for performance tracking and analytics.
\nGET
\nWhen a 400 Bad Request response is returned, the body may contain one or more of these possible errors:
\nThis value should be of epoch unix timestamp.
\nThe value of order_by should be either asc or desc.
(Optional) The date when the emails are published starts. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"from_date","value":"(Optional) The date when the emails are published ends. This is in epoch unix timestamp.
\n","type":"text/plain"},"key":"to_date","value":"A company that has subscription pages outside the Swift Digital Suite platform, like a subscription form on a website. When a website visitor subscribes to a newsletter or other communications, their contact information should automatically be captured and sent to Swift Digital Suite via the REST API. This ensures that all subscriber data is centralised, up-to-date, and ready for marketing campaigns.
\nThe subscriptions made on the website form are automatically sent to the Swift Digital Suite platform.
\nThe website has a subscription form that captures at least the first name, last name, and email.
\nThe website has valid API credentials for Swift Digital Suite (Client ID, Client Secret, and T3 Account ID).
\nAPI access to Swift Digital Suite is available and authenticated.
\nThe domain of the website subscription form and the thank you page need to be whitelisted by Swift Digital Suite. A request for whitelisting has to be sent to api@swiftdigital.com.au
\nThe subscriber is added to the mail house module of your account in the Swift Digital Suite platform.
\nThe subscriber may receive a welcome email depending on the workflow set.
\nSubscriber Submits on the Subscription Form on the Website
\nWebsite Validates Form Data
\nWebsite calls the Swift Digital API to Authenticate
\nCall POST /auth/token
The response includes access_token
Reference: Swift Digital Suite API Auth/Token
\nAPI Request: Subscription/Join
\nCall POST /mailhouse/subscription/join
The request body includes the first name, last name, email, custom fields, and mail groups.
\nReference: Swift Digital Suite API Subscription/Join
\nAPI Response: Subscription/Join
\nIf successful, the API returns the message The double opt-in verification email has been sent.
The double opt-in verification email is sent to the subscriber.
\nThe subscriber has to confirm the subscription by clicking the verify email button on the double opt-in verification email.
\nVerify the Subscription
\nShows a thank-you message and triggers a welcome email (if been set on the mail groups).
\nOnly after clicking the verify email button on the double opt-in verification email is the subscriber added to the nominated mail group on the mail house.
\nThe inputted subscriber details and selected mail group on the website form are reflected in your account on the Swift Digital Suite platform.
\nA company that uses a CRM system (e.g., Salesforce, Dynamics 365) to manage customer relationships and the Swift Digital Suite as the marketing automation platform (email campaigns, event management, surveys, etc.). To ensure consistent customer data across both platforms, the CRM should integrate with the Swift Digital Suite REST API for Contact management.
\nCRM User: Sales or marketing staff managing customer data.
\nCRM System (e.g., Salesforce, Dynamics 365): Primary system of record for customer details.
\nSwift Digital Suite API: Provides endpoints to create, update, and manage both contacts and mail groups.
\nThe marketing staff manages contacts in the CRM application. Whenever a new contact is created or an existing contact is updated in the CRM, these updates are synced to the Swift Digital Suite platform.
\nContact Creation or Update in CRM
\nAPI Request: Create/Update Contact
\nCall POST /mailhouse/contact/create or POST /mailhouse/contact/update
The request body includes the mapped fields (e.g first name, last name, email, custom fields, mail groups)
\nReference: Swift Digital Suite API Contact/Create or Contact/Update
\nAPI Response
\nIf successful, the API returns the contact_id.
\nThe contacts that were created or updated from the CRM are reflected in your account on the Swift Digital Suite platform.
\nDuplicate Contact Handling
\nIf the contact already exists in Swift Digital Suite (found as a duplicate), the API may return an error or the contact details.
\nIntegration should call the update endpoint (/mailhouse/contact/update) instead.
Error Handling
\nAPI returns a validation error (e.g., invalid email).
\nLog the error and notify the user to correct the data.
\nThe marketing staff creates a list of contacts in the CRM application. This list needs to be integrated into the Swift Digital Suite platform through a mail group.
\nExport the Contacts
\nAPI Request: Create Mail Group
\nCall POST /mailhouse/mailgroup/create
The request body includes the name of the mail group, the folder, and whether the mail group is a test.
\nReference: Swift Digital Suite API Mailgroup/Create
\nAPI Request: Create/Update Contact
\nCall POST /mailhouse/import/csv or POST /mailhouse/import/zip
The CSV or ZIP file needs to be converted to BASE 64.
\nThe request body includes the file content and mapped fields (e.g first name, last name, email, custom fields, mail groups)
\nReference: Swift Digital Suite API Import/CSV or Import/ZIP
\nAPI Response
\nIf successful, the API returns the import_id.
\nThe contacts that come from inside the list from the CRM are reflected on the specified mail group in your account on the Swift Digital Suite platform.
\nError Handling
\nAPI returns a validation error (e.g., invalid mail group ID).
\nA comprehensive import report is generated in the Mail House > Import/Export > Import Queue section of your account on the Swift Digital Suite platform after the import process is completed.
\nThe import report includes blank rows, invalid email addresses, invalid mobile, etc..
\n