The Upaknee Enterprise REST API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients.
\nUsing a typical REST approach, each interface will interact with the systems using a given URL, such as
\n\n\nhttps://{{api_host}}/resource/parameters
\n
We can understand the URL in the following parts:
\n\n\nhttps://{{api_host}}
\n
The system directs the request to the appropriate application server with the specified port. For all API interactions, port 443 should be used, which can be represented by https:// instead of designating the port number.
\n\n\n/resource
\n
This next part of the URL mapping designates the resource and is further followed by annotations to the class.
\n\n\n/parameters
\n
Objects/Parameters are specified according to the class definition. Parameter operators may also appear within the XML payload for PUT and POST requests to influence the behavior of the system. These are specifically detailed within each respective route in the documentation.
\n\n\n?filters=values
\n
Filters to limit the result set of the /resource/parameter; particularly used in GET requests.
\nAll data sent to and from the API must be in XML format. Many coding languages include utilities to convert data structures to use an XML structure and vice versa. Certain routes are available in JSON. If you prefer to use JSON please contact us and we will review and update our code as necessary.
\nUse of Tokens and Authentication
\nOur API follows most conventions of RESTful architecture. Any requests which require authentication must always be authenticated, as our servers do not retain information from previous requests. Our routes are reliably simple and require only a few levels of nesting.
\nAll interfaces within this documentation must be accessed via the appropriate REST environment using a token authentication method. A token identifies the target account and contact list on which to perform the action. A token is obtained from Upaknee via the Settings tab of Campaign Manager and is a 32 alpha numeric character string with an optional additional security password.
\nChanges to this document
\nPlease note that this documentation is a work in progress and will be updated as necessary. We provide example API requests throughout the documentation. If you have a code example you’d like us to include in these docs, please let us know. We’ll review the code and add to the documentation as soon as possible.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4695669","collectionId":"5223c899-b934-4690-849d-110dca632b38","publishedId":"SzKYNcA5","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00a9fc"},"publishDate":"2022-08-11T05:33:09.000Z"},"item":[{"name":"General","item":[{"name":"GET API Version","id":"a5e5d1e9-1974-4535-98eb-0dc34172881b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{token}}"},{"key":"password","value":"Specifies the format accepted by the API.
\n","type":"text"},{"key":"Content-Type","value":"application/xml","description":"Specifies the correct format of the request in XML.
\n","type":"text"}],"url":"https://{{api_host}}/version","description":"Retrieve the currently deployed API version for this API endpoint.
\n","urlObject":{"protocol":"https","path":["version"],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"f1849fb9-a324-4cc6-9f78-8633c0b606e0","name":"GET API Version","originalRequest":{"method":"GET","header":[],"url":"https://{{api_host}}/version"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.10.2"},{"key":"Date","value":"Wed, 04 Mar 2020 08:26:57 GMT"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-UA-Compatible","value":"IE=Edge,chrome=1"},{"key":"ETag","value":"W/\"2b267a00edf408e9aa8cfa713bffa194\""},{"key":"Cache-Control","value":"must-revalidate, private, max-age=0"},{"key":"X-Request-Id","value":"4e343df2e6326c96f1d53521bcffbff4"},{"key":"X-Runtime","value":"0.012237"},{"key":"X-Rack-Cache","value":"miss"},{"key":"X-Rack-CORS","value":"preflight-hit; no-origin"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\nUse the following to read information regarding the configuration of your account.
\n","event":[{"listen":"prerequest","script":{"id":"556b450d-4db9-4ecd-b239-5aae4dd8804f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"04745742-5c41-47c8-aab8-d79ca422c070","type":"text/javascript","exec":[""]}}],"_postman_id":"44a1c767-2bed-452c-96f7-1d9b6590402e","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Specifies the format accepted by the API.
\n","key":"Accept","type":"text","value":"application/xml"},{"description":"Specifies the correct format of the request in XML.
\n","key":"Content-Type","type":"text","value":"application/xml"}],"url":"https://{{api_host}}/subscribers/{{profile-id}}","description":"A single record can be retreived using it's primary key, profile-id. Only one record will be returned if it exists within the list.
\n","urlObject":{"protocol":"https","path":["subscribers","{{profile-id}}"],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"3cf8472b-4088-43ae-9f13-751968584ae2","name":"Subscriber record does not exist","originalRequest":{"method":"GET","header":[{"description":"Specifies the format accepted by the API.","key":"Accept","type":"text","value":"application/xml"},{"description":"Specifies the correct format of the request in XML.","key":"Content-Type","type":"text","value":"application/xml"}],"url":"https://{{api_host}}/subscribers/{{profile-id}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"openresty/1.15.8.2"},{"key":"Date","value":"Tue, 14 Apr 2020 04:43:55 GMT"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-UA-Compatible","value":"chrome=1"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Request-Id","value":"5b2a9c4f7fd13fc9afb4b0105ebd63db"},{"key":"X-Runtime","value":"0.006100"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\nSpecifies the format accepted by the API.
\n","key":"Accept","type":"text","value":"application/xml"},{"description":"Specifies the correct format of the request in XML.
\n","key":"Content-Type","type":"text","value":"application/xml"}],"url":"https://{{api_host}}/subscribers?email={{email-address}}","description":"The list can also be searched for a matching email address, using the email address filter parameter. Only matching records will be returned in the result set.
\n","urlObject":{"protocol":"https","path":["subscribers"],"host":["{{api_host}}"],"query":[{"key":"email","value":"{{email-address}}"},{"disabled":true,"key":"record_id","value":"{{record-id}}"},{"disabled":true,"key":"secondary-email","value":"{{secondary-email}}"}],"variable":[]}},"response":[{"id":"03e2f771-0dfb-4fe3-a40b-33795b5e498c","name":"Matching Email Record Found","originalRequest":{"method":"GET","header":[{"description":"Specifies the format accepted by the API.","key":"Accept","type":"text","value":"application/xml"},{"description":"Specifies the correct format of the request in XML.","key":"Content-Type","type":"text","value":"application/xml"}],"url":{"raw":"https://{{api_host}}/subscribers?email=test1@upaknee.com","protocol":"https","host":["{{api_host}}"],"path":["subscribers"],"query":[{"key":"email","value":"test1@upaknee.com"},{"key":"record_id","value":"{{record-id}}","disabled":true},{"key":"secondary-email","type":"text","value":"{{secondary-email}}","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"openresty/1.15.8.2"},{"key":"Date","value":"Tue, 14 Apr 2020 04:21:38 GMT"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-UA-Compatible","value":"chrome=1"},{"key":"ETag","value":"W/\"114c86b6a8f985ad592d97c941f5a10b\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"24a6724e8a4b0981867dd65bfdbc2660"},{"key":"X-Runtime","value":"0.074818"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"Specifies the format accepted by the API.
\n","key":"Accept","type":"text","value":"application/xml"},{"description":"Specifies the correct format of the request in XML.
\n","key":"Content-Type","type":"text","value":"application/xml"}],"url":"https://{{api_host}}/subscribers?record_id={{record-id}}","description":"The list can also be searched by specifying the internal system ID, using the record-id filter parameter. Only a single matching record will be returned in the result set.
\n","urlObject":{"protocol":"https","path":["subscribers"],"host":["{{api_host}}"],"query":[{"disabled":true,"key":"email","value":"{{email-address}}"},{"key":"record_id","value":"{{record-id}}"},{"disabled":true,"key":"secondary-email","value":"{{secondary-email}}"}],"variable":[]}},"response":[{"id":"4b803e2a-cbeb-467e-9187-bc741a1cd8c8","name":"No Matching Records Found","originalRequest":{"method":"GET","header":[{"description":"Specifies the format accepted by the API.","key":"Accept","type":"text","value":"application/xml"},{"description":"Specifies the correct format of the request in XML.","key":"Content-Type","type":"text","value":"application/xml"}],"url":{"raw":"https://{{api_host}}/subscribers?record_id={{record-id}}","protocol":"https","host":["{{api_host}}"],"path":["subscribers"],"query":[{"key":"email","value":"{{email-address}}","disabled":true},{"key":"secondary-email","type":"text","value":"{{secondary-email}}","disabled":true},{"key":"record_id","value":"{{record-id}}"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"openresty/1.15.8.2"},{"key":"Date","value":"Tue, 14 Apr 2020 04:29:52 GMT"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-UA-Compatible","value":"chrome=1"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Request-Id","value":"d7601652018e59ec58fc7ba48603c1db"},{"key":"X-Runtime","value":"0.005167"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\nThis method is built for use in websites and integrations that need to add subscribers on a subscriber-by-subscriber basis, and adds a subscriber to an existing subscriber list, including custom field data if supplied.
\nRole-based Email Addresses: Role based email addresses are generally considered non-compliant with various relevant anti-spam legislation and are not permitted to be added to a primary contact list. Role-based email creation is rejected by default, and suppressed by the system. It is possible to \"grandfather\" a list of exempted email addresses from this suppression check. However, if a subscriber later changes their email address to a non-grandfathered email or regular email address, and then later also changes their email back to the original \"grandfathered\" email address, the exemption will no longer apply and the creation of the email will be rejected and/or suppressed by the system.
\n","urlObject":{"protocol":"https","path":["subscribers",""],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"422799eb-0385-45c1-9402-1d80337d655f","name":"Create a Subscriber (simple)","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml"},{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"If the subscriber (by email address) already exists, the update-existing parameter can be invoked within the payload (for each subscriber) and an operation will be performed on any record in the system that has a matching email address. Any subscriber attributes also passed in the request payload, such as name and any custom field values will be updated with whatever is provided.
\nWhen passing the update-existing parameter in the payload of the POST body of the /subscriber call, this will serve to search the list based on email address, and update a record if found, and if not found will proceed to create the email address as normal. See the result returned to understand if an update or a create was performed based on the result.
\nProviding a request payload as is illustrated in the example, for a subscriber record with an email address previously existing on the list, without any additional subscriber attributes and/or any subscriptions will in net effect do nothing to the list, and will retain all statuses for the profile record. This interface route and method is primarily useful when also passing subscriptions as a part of the subscriber creation request payload, such that subscriptions are also appended to any existing subscribers. Please see the following link for a useful application using this parameter.
\n","urlObject":{"protocol":"https","path":["subscribers",""],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"08c947c4-aa7b-4e3c-a450-129dbce43372","name":"Create request updates a pre-existing email address","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml"},{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"Default: false
\nWhen passing the suppress-confirmation parameter in the payload of the POST body of the /subscriber call, this will serve to directly activate the email address on the list, that is to set the to active. It will also suppress the double opt-in confirmation email that is automatically generated by the system and sent to the recipient via the supplied subscriber's email address.
\nOutcome/Results
\nDefault: false
\nWhen passing the suppress-confirmation=true parameter in the payload and providing a parameter of status=pending of the POST body of the /subscriber call, this will serve to create the email address on the list, that is to set the to PENDING. It will also suppress the double opt-in confirmation email that is automatically generated by the system and sent to the recipient via the supplied subscriber's email address.
\nOutcome/Results
\nAdd additional information to the subscriber record, including source of the subscriber record.
\nFields must be previously existing within the Primary Contact List, and if not an error will be thrown, and the record will fail to create.
\nOutcome/Results
\nsource is added to a subscriber record on initial creation only; sources provided and used in create/update of subscriptions will cascade down to become the source of the subscription.Any actions associated with a newsletter will be automatically triggered by setting the value within the subscriptions payload to true. Actions, such as a \"welcome email\" trigger, are invoked in tandem with creating or updating a subscriber record. Actions can be invoked on a newsletter subscription-by-subscription basis, or specified once to act on all provided actions, based on the locaiton of the parameter in the payload.
\nOutcome/Results
\nThis method is useful to update subscriber attributes, when the is known, or can be retrieved by the calling application using the GET /subscribers?email={search-for-email} method; see method here. If the is not known, an alternative method to update a profile is to initiate a Subscriber Create call via POST /subscribers and submit the existing-update=true parameter; see method here.
\nResult/Outcome:
Editing an email address using the PUT method will automatically send a confirmation email to the newly provided email address and put the subscriber record into pending status. The record will remain in pending status until the recipient clicks on the activation link within the email.
The numbered examples are continued in Batch retrieval and Batch detail retrieval.
\nThe batch submission request supports several different parameter and metadata placement within the request:
\nBatch and Subscriber parameters
\nBatch metadata
\nSubscriber metadata (common attributes)
\nSubscription parameters
\nSubscription metadata
\nProfile and subscription data integrity concerns
\noperation: The action to be taken against each profile in the batch. Please note the considerations below.
When using the operation parameter update, a profile-id must be provided to locate the record for which to perform the update. If the record was originally created with a system-assigned profile-id, or if the profile-id is unknown, the value can be determined by querying by email address; (See: Search for Subscriber by email, for GET /subscribers?email={{email-address}}).
When using the operation parameter create, the update- existing parameter may also be used. When true, update existing will create a profile if the record does not already exist and update the existing profile if one is found. Existing records will be identified by matching on email address.
suppress-confirmation: When true, the profile will not be sent a confirmation email when created or its email updated. The profile's status will also move directly to active, bypassing the pending status that is otherwise used until the subscriber confirms their email address. This tag is only relevant for accounts with confirmation emails enabled. This setting should only be set to true if consent has been obtained in an alternate system or process and is recorded and can be produced for compliance requirements.
newsletter-id: this tag serves only to associate the batch with the given newsletter. A newsletter's associated batches can be viewed within Campaign Manager under the Sources tab.
source can be provided at the batch level and it's value will be cascaded to subscriber source and/or subscription source if they are not explicitly provided.
Subscriber fields can be updated with common values for all subscriber submitted in the batch request, such that common values do not need to be explicitly enumerated for each individual subscriber record. Common attributes will have the space value applied to all records.
\nnewsletter-id: this tag serves only to associate the batch with the given newsletter. A newsletter's associated batches can be viewed within Campaign Manager under the Sources tab.
source can be provided to be used for newly created profiles and it's value will be cascaded to subscription source if is not explicitly provided.
actions: Any associated/linked actions, such as subscriptions, or triggered mailings (i.e. welcome emails) will initiate on the subscription operation (if successful).
automations: Initiate all associated automations that are linked to the preference(s) specified and will occur on the subscription operation (if successful).
resubscribe: When true, profiles will be resubscribed to all newsletters specified in the batch. When false, profiles will not be resubscribed from newsletters where the current subscription status is unsubscribed. Attempts to resubscribe users who currently have an active subscription status for the preference will be ignored. Depending upon your account configuration and, if applicable, integration scope, setting this value to false can ensure that profiles are not erroneously resubscribed to newsletters, and is recommended.
source is the original source of the subscription capture, and can be any value that is meaningful to your compliance and reporting concerns. We recommend that this value be specific and related to the actual capture of the subscription consent for the subscriber. This value will not be inherited by any other source attribute in the batch request.
Profile and subscription data is supported in the same format as single subscriber requests. In the subsections below, endpoint-specific documentation and considerations have been outlined. See the Subscribers and Subscribers > Subscriptions documentation above for shared documentation.
\nSubscriber batches support the inclusion of profile ID, email, or both. When operation=update or operation=create with update-existing=true and where both a profile ID and email address is included an attempt is first made to identify an existing profile using the profile ID. If a profile is not found, a second attempt is made to identify an existing profile using the email.
As a result, this endpoint supports email address changes but does not support profile ID changes. To change a profile's profile ID, a request must be made against the profile itself. See Subscribers > Auto-Assign > Update Subscriber Attributes for documentation.
\nIn the event of parameter conflicts (i.e., a parameter provided with different values at different locations), the inner-most value will be applied to the profile.
\nIn example 2, the inner-most value of true for suppress-confirmation is applied to the profile, and it is created without sending a confirmation email and directly into an active profile status.
In the event of subscription data conflicts, the specified newsletters will be combined between the levels (i.e., batch-level and profile-level), whereas the subscription parameters will apply only to the level within which it is specified.
\nIn example 3, the batch-level subscriptions field specifies newsletter 2 with actions=false and, for profile A00001 (Jane) only, newsletter 3 with actions=true. During processing:
Both profiles will be subscribed to newsletter 2 without actions
\nOnly profile A00001 will be subscribed to newsletter 3, and with actions
Subscriber batches can be retrieved through the root endpoint (to retrieve multiple batches) or, as shown here, by including a specific batch ID. The fields of note are below.
\n*Note: Apart from exceptional error cases, the following should be true: subscribers = subscribers-processed = pending + errors + successful.
An alphanumberic value return from a batch submission request.
\n","type":"text/plain"},"type":"any","value":"string","key":"batch_id"}]}},"response":[{"id":"16175dbc-20cf-4912-a646-472b205af1f2","name":"Example 1: Batch retrieval","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Accept","value":"application/xml","type":"text"}],"url":"https://{{api_host}}/subscriber_requests"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml; charset=utf-8","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\nA batch detail represents a single profile submitted within a batch. For example, a batch submitted with creation requests for 10 profiles will contain 10 details. The fields of note are below.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"An alphanumberic value return from a batch submission request.
\n","type":"text/plain"},"type":"any","value":"string","key":"batch_id"}]}},"response":[{"id":"d49dfd1f-8bf2-492c-a5d1-3a0a50de30fc","name":"Example 1: Batch detail retrieval","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"Accept","value":"application/xml","type":"text"}],"url":"https://{{api_host}}/subscriber_requests/1d3b4e19999d9f34/details"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml; charset=utf-8","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\nThe URL-encoded email address to search.
\n","type":"text/plain"},"key":"email","value":"{{email}}"}],"variable":[]}},"response":[{"id":"f7a24532-04fd-4945-bb1f-546dadd1af2c","name":"Search batch details by email","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{api_host}}/subscriber_requests/details?email=jane.doe@example.com","protocol":"https","host":["{{api_host}}"],"path":["subscriber_requests","details"],"query":[{"key":"email","value":"jane.doe@example.com","description":"The URL-encoded email address to search."}]}},"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"\nOrder results from oldest to newest (i.e., asc) or newest to oldest (i.e., desc).
\n","type":"text/plain"},"key":"order","value":"string"},{"disabled":true,"description":{"content":"The number of results to return. Default is 10.
\n","type":"text/plain"},"key":"limit","value":"integer"},{"disabled":true,"description":{"content":"The position of the batch at which to start the results. Default is 0.
\n","type":"text/plain"},"key":"offset","value":"integer"}],"variable":[{"id":"763967ad-6848-421e-9cb8-ce9688fab66d","description":{"content":"The ID of the newsletter
\n","type":"text/plain"},"type":"any","value":"integer","key":"newsletter_id"}]}},"response":[{"id":"8e9ac90a-c42d-4ef3-8db5-4d28308ad404","name":"Retrieve subscriber requests by newsletter","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_host}}/newsletters/:newsletter_id/subscriber_requests?order=asc&limit=1&offset=0","host":["{{api_host}}"],"path":["newsletters",":newsletter_id","subscriber_requests"],"query":[{"key":"order","value":"asc","description":"Order results from oldest to newest (i.e., asc) or newest to oldest (i.e., desc)."},{"key":"limit","value":"1","description":"The number of results to return. Default is 10."},{"key":"offset","value":"0","description":"The position of the batch at which to start the results. Default is 0."}],"variable":[{"key":"newsletter_id","value":"integer","description":"The ID of the newsletter"}]}},"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"\nSpecifies the format accepted by the API.
\n","key":"Accept","type":"text","value":"application/xml"},{"description":"Specifies the correct format of the request in XML.
\n","key":"Content-Type","type":"text","value":"application/xml"}],"url":"https://{{api_host}}/subscribers","description":"Retrieves a list of all subscriber’s details including their email address, name, active/inactive state, and any custom field data. Results are limited to 10 results by default, filter parameter values can be provided to increase the result set and page through all subscribers in the list.
\nLimit, Offset and Order *used to step through the entire list, with paginated results. Limits < 500 should be used for optimal performance.
\nThis interface route may be disabled on your account. If the route is not accessible, please contact Upaknee Customer Support to have access enabled.
\n","urlObject":{"protocol":"https","path":["subscribers"],"host":["{{api_host}}"],"query":[{"disabled":true,"description":{"content":"integer value; optional
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"integer value; optional
\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"asc, desc; optional, default is ascending order
\n","type":"text/plain"},"key":"order","value":"desc"}],"variable":[]}},"response":[{"id":"00519c9e-9265-4433-acd4-56faa679fb07","name":"with no parameters specified","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml","description":"Specifies the format accepted by the API.","type":"text"},{"key":"Content-Type","value":"application/xml","description":"Specifies the correct format of the request in XML.","type":"text"}],"url":{"raw":"https://{{api_host}}/subscribers","protocol":"https","host":["{{api_host}}"],"path":["subscribers"],"query":[{"key":"limit","value":"10","disabled":true},{"key":"offset","value":"0","disabled":true},{"description":"Provides the ability to search the list, and return a record with a matching email address. Note that email address provided must be URL encoded.","key":"email","type":"text","value":"{{search-for-email-address}}","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.10.2"},{"key":"Date","value":"Wed, 04 Mar 2020 08:17:05 GMT"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-UA-Compatible","value":"IE=Edge,chrome=1"},{"key":"ETag","value":"W/\"4ed2d7073893e9604c725550c5f97547\""},{"key":"Cache-Control","value":"must-revalidate, private, max-age=0"},{"key":"X-Request-Id","value":"73f3c107a151f724fd09c9bd6e68a2b2"},{"key":"X-Runtime","value":"0.255948"},{"key":"X-Rack-Cache","value":"miss"},{"key":"X-Rack-CORS","value":"preflight-hit; no-origin"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"Subscriber batches (officially, subscriber requests) enables support for creating or updating multiple profiles within a single API request.
\nThe batch will be processed asynchronously and can be retrieved through the API to check it's completion status and other metadata.
\n","_postman_id":"443c9756-2afc-44b6-979e-bf71cce5b091","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The following apply to the auto-assigned mode of operations. Auto-assigned configurations do not require a customer-supplied profile-id (UUID) to be used as a primary key in submission of initial subscriber create requests (and in any other compound call where subscribers are created). They will assign an automatically generated system-id as the profile-id, when encountering a new email address in the subscribe request.
\nThis method is built for use in websites and integrations that need to add subscribers on a subscriber-by-subscriber basis, and adds a subscriber to an existing subscriber list, including custom field data if supplied. To add subscribers in bulk, please use the Batch Subscribers method.
\nThe call can also be modified by using in-payload parameters to:
\nThe system has the following status states on each subscriber record, and is regulated by email address. Status is for the subscriber record and not for each newsletter subscription.
\nStatus is important for email sending rules.
\nactive subscribersactive or pending statusactive status only or for membership to the preference/existence of a subscription.Invoke a status change from any status to 'active' status. This will activate any consent-required newsletter subscription permissions.
\n","urlObject":{"protocol":"https","path":["subscribers","{{profile-id}}","activate"],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"2884659c-335c-452c-8c57-b12462b839d8","name":"Subscriber Activated","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml","type":"text"},{"key":"Content-Type","value":"application/xml","type":"text"}],"url":"https://{{api_host}}/subscribers/{{profile-id}}/activate"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"openresty/1.15.8.2"},{"key":"Date","value":"Tue, 14 Apr 2020 08:26:42 GMT"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-UA-Compatible","value":"chrome=1"},{"key":"ETag","value":"W/\"8b42d4706d7a51bbb34fc96392cb6487\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"d125e705f6fefa8b7e7957ab256c89ed"},{"key":"X-Runtime","value":"0.008389"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\nThis will move a subscriber's email and record status to 'pending' from any state, and will invoke a sending of the double opt-in confirmation email to the subscriber at the email address associated with the subscriber record.
\nThe call will invoke a send of a confirmation email to the email address associated with the record and put the subscriber record into pending status. The record will remain in pending status until the recipient clicks on the activation link within the email.
Specifies the format accepted by the API.
\n","type":"text"},{"key":"Content-Type","value":"application/xml","description":"Specifies the format accepted by the API.
\n","type":"text"}],"url":"https://{{api_host}}/subscribers/{{email-address}}/validate","description":"Check an email address to see if it will be accepted by the system.
\nCampaign Manager will detect and restrict an invalid email. The following are the steps the system will\ntake to validate emails for Campaign Manager:
\nAllow only alpha numeric characters and the following symbols: .!#$%&'*+/=?^_`{|}~-\nThis step ensures that the email does not start with a . (period)
\nThis step also enables the use of double quotes “” for special characters. Any characters placed in\ndouble quotes will be accepted by the system. This is most commonly applied for accented characters.
\nDiscuss all possible status states for email and SMS.
\n","_postman_id":"34922e40-8ecc-4346-9563-053189bb4141","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This method is built for use in websites and integrations that need to add a subscription to a newsletter preference on a subscriber-by-subscriber basis, and adds a subscription to an existing newsletter list.
\n","urlObject":{"protocol":"https","path":["subscribers","{{profile-id}}","subscriptions"],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"0fb7c9a2-98f0-4b83-850b-fe7a65cc3890","name":"Subscription Added to Subscriber Record","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml","type":"text"},{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"Multiple subscriptions to newsletters for a given subscriber can performed as well.
\n","urlObject":{"protocol":"https","path":["subscribers","{{profile-id}}","subscriptions"],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"c656e716-1638-4cb6-91ce-3f1f37a527c3","name":"Subscriptions Added to Subscriber Record","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml","type":"text"},{"key":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"Retrieve a list of subscriptions associated with a given subscriber.
\n","urlObject":{"protocol":"https","path":["subscribers","{{profile-id}}","subscriptions"],"host":["{{api_host}}"],"query":[{"description":{"content":"integer, optional
\n","type":"text/plain"},"key":"limit","value":"{{limit-number}}"},{"description":{"content":"integer, optional
\n","type":"text/plain"},"key":"offset","value":"{{offset-number}}"},{"description":{"content":"Specify a value (active, pending, unsubscribe, or all)
\n","type":"text/plain"},"key":"status","value":"{{status}}"}],"variable":[]}},"response":[{"id":"7afde750-7494-4d78-ae50-7de6a672c1dc","name":"Get ALL Subscriptions with any Subscription Status by Subscriber","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/xml"},{"key":"Content-Type","type":"text","value":"application/xml"}],"url":{"raw":"https://{{api_host}}/subscribers/6920762/subscriptions?limit=50&offset=0&status=all","protocol":"https","host":["{{api_host}}"],"path":["subscribers","6920762","subscriptions"],"query":[{"key":"limit","value":"50"},{"key":"offset","value":"0"},{"key":"status","value":"all","description":"Specify a value (active, pending, unsubscribe, or all) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.17.8"},{"key":"Date","value":"Thu, 22 Oct 2020 05:13:08 GMT"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-UA-Compatible","value":"chrome=1"},{"key":"ETag","value":"W/\"180250442ac85a7224affb2aac0d5589\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"13806df5649e435183f59961c2462966"},{"key":"X-Runtime","value":"0.033085"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"Get a specific record using its profile id.
\n","urlObject":{"protocol":"https","path":["subscribers","{{profile-id}}","subscriptions","1","events"],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"79279d98-4fad-420d-b023-e34a6658542c","name":"Get Subscription Events by Subscriber","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml"},{"key":"Content-Type","value":"application/xml"}],"url":"https://{{api_host}}/subscribers/{{profile-id}}/subscriptions/{{newsletter-id}}/events"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.17.8"},{"key":"Date","value":"Wed, 21 Oct 2020 19:55:54 GMT"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-UA-Compatible","value":"chrome=1"},{"key":"ETag","value":"W/\"0f661c1d76d2bf5a8516fa4570bb39dc\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"da65ccec890df3436ee77893247d71d2"},{"key":"X-Runtime","value":"0.013736"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\nThis call performs an update (subscribe and unsubscribe) to preferences provided (and not provided in the payload). This call is meant to influence the final state of the subscriptions for a subscriber and is useful when subscriptions held within the system are meant to mirror those captured and held in another third-party system.
\nAs there may be unintended consequences when using this route, caution and planning should be exercised. It is recommended wherever possible to use the POST and DEL routes to create and remove subscriptions discretely per newsletter.
\n","urlObject":{"protocol":"https","path":["subscribers","{{profile-id}}","preferences"],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"b0da82e2-5c8f-4c44-a083-fd5806248797","name":"Error - 404 Not Found","originalRequest":{"method":"PUT","header":[],"url":"https://{{api_host}}/subscribers/1111111/preferences"},"status":"Not Found","code":404,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.10.2"},{"key":"Date","value":"Wed, 01 Apr 2020 16:07:12 GMT"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-UA-Compatible","value":"IE=Edge,chrome=1"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Request-Id","value":"ec3116b122eeb198d927c4d6c9d2c407"},{"key":"X-Runtime","value":"0.016830"},{"key":"X-Rack-Cache","value":"invalidate, pass"},{"key":"X-Rack-CORS","value":"preflight-hit; no-origin"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\nEverything you need to work with subscribers in your account. From adding a single subscriber to importing a large list.
\n","event":[{"listen":"prerequest","script":{"id":"f8303849-5c5d-470e-8338-1dba4fc59809","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1bd3bcb1-7516-4cab-878b-fb21e8b11f7e","type":"text/javascript","exec":[""]}}],"_postman_id":"37535fa8-27d7-47ea-8cc6-50e908d8c9c0","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"YYYY-MM-DD HH:MM:SS; e.g. 2018-08-21-0:00:00:00
\n","type":"text/plain"},"key":"from","value":"{{from-date}}"},{"description":{"content":"YYYY-MM-DD HH:MM:SS; e.g. 2018-08-21-05:01:00:00
\n","type":"text/plain"},"key":"to","value":"{{to-date}}"}],"variable":[]}},"response":[],"_postman_id":"a0eb21c3-e148-4751-ae5c-81781ce492d6"},{"name":"Retrieve subscription growth by newsletter","id":"3a9fc7d1-ffeb-4dc5-8c34-b518d097a44a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{token}}"},{"key":"password","value":"YYYY-MM-DD HH:MM:SS; e.g. 2018-08-21-0:00:00:00
\n","type":"text/plain"},"key":"from","value":"{{from-date}}"},{"description":{"content":"YYYY-MM-DD HH:MM:SS; e.g. 2018-08-21-05:01:00:00
\n","type":"text/plain"},"key":"to","value":"{{to-date}}"}],"variable":[]}},"response":[],"_postman_id":"3a9fc7d1-ffeb-4dc5-8c34-b518d097a44a"},{"name":"Retrieve unique subscription growth across one or more newsletters","id":"47cc0c31-da88-44b4-9ee0-ee05de24195b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{token}}"},{"key":"password","value":"true, false; default is false
\n","type":"text/plain"},"key":"unique","value":"{{unique}}"},{"description":{"content":"Comma-separated newsletter IDs; can provide one or more; e.g. 1,2,3
\n","type":"text/plain"},"key":"newsletters","value":"{{newsletter-id-1,newsletter-id-2}}"},{"description":{"content":"YYYY-MM-DD HH:MM:SS; e.g. 2018-08-21-0:00:00:00
\n","type":"text/plain"},"key":"from","value":"{{from-date}}"},{"description":{"content":"YYYY-MM-DD HH:MM:SS; e.g. 2018-08-21-0:00:00:00
\n","type":"text/plain"},"key":"to","value":"{{to-date}}"}],"variable":[]}},"response":[],"_postman_id":"47cc0c31-da88-44b4-9ee0-ee05de24195b"},{"name":"Retrieve total number of newsletters (count)","id":"1ce21534-6a11-4223-984c-78a6a4f57893","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{token}}"},{"key":"password","value":"Users can request to send a batch at a particular date and time in the future when it is submitted to Upaknee Enterprise REST API.
\nInclude in the body of the batch submission request between the and XML fields.
\nThe parameter supports the following 3 formats:
\n‘TZ’ format is always expressed as UTC time. Before submitting your scheduled batch, be sure to convert your time to UTC. You can use this site to help (note: the link defaults to Eastern to GMT which, for the purposes of this documentation, can be equated to UTC).
\nNote: Be sure to consider Daylight Savings Time (DST) when converting your time to UTC/GMT. For example, in Toronto, we are 4 hours behind during DST and 5 hours behind otherwise.
\n","urlObject":{"protocol":"{{api_protocol}}","port":"{{api_port}}","path":["triggers",":trigger-name","mailings"],"host":["{{api_host}}"],"query":[],"variable":[{"id":"a177fcc2-69ad-4c8d-851a-8b5fbb6579fe","type":"any","value":"{{trigger-name}}","key":"trigger-name"}]}},"response":[],"_postman_id":"3f27b601-1da0-4fd4-aea8-485e61263261"}],"id":"63372478-b429-450f-804c-0c0c8aae8431","_postman_id":"63372478-b429-450f-804c-0c0c8aae8431","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Webhooks sent using the GET method provide data as URL-encoded query string parameters. For ease of understanding, this documentation and its examples do not URL envode the parameters.
The unique identifier for the profile that is set upon profile creation or update.
\n","type":"text/plain"},"key":"profile_id","value":"string "},{"disabled":true,"description":{"content":"The email address for the profile.
\n","type":"text/plain"},"key":"email","value":"string"},{"disabled":true,"description":{"content":"The subscription event that took place. Supported events: subscribe, unsubscribe.
\n","type":"text/plain"},"key":"event","value":"string"},{"disabled":true,"description":{"content":"The newsletter ID to which the profile subscribed to or unsubscribed from.
\n","type":"text/plain"},"key":"newsletter_id","value":"integer"},{"disabled":true,"description":{"content":"The date and time at which the subscription event occurred.
\n","type":"text/plain"},"key":"time","value":"string"}],"variable":[]}},"response":[{"id":"3158473a-ebeb-4396-80c6-fb31839e0b62","name":"Subscribe event","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml","type":"text"}],"url":{"raw":"https://example.com/webhooks?profile_id=A00001&email=jane.doe@example.com&event=subscribe&newsletter_id=2&time=2022-01-01 00:00:00 -0400","protocol":"https","host":["example","com"],"path":["webhooks"],"query":[{"key":"profile_id","value":"A00001","description":"The unique identifier for the profile that is set upon profile creation or update."},{"key":"email","value":"jane.doe@example.com","description":"The email address for the profile."},{"key":"event","value":"subscribe","description":"The subscription event that took place. Supported events: subscribe, unsubscribe."},{"key":"newsletter_id","value":"2","description":"The newsletter ID to which the profile subscribed to or unsubscribed from."},{"key":"time","value":"2022-01-01 00:00:00 -0400","description":"The date and time at which the subscription event occurred."}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"532a0b86-7855-46a0-83ed-1e65e3ef9161","name":"Unsubscribe event","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml","type":"text"}],"url":{"raw":"https://example.com/webhooks?profile_id=A00457&email=john.doe@example.com&event=unsubscribe&newsletter_id=6&time=2022-01-01 00:00:00 -0400","protocol":"https","host":["example","com"],"path":["webhooks"],"query":[{"key":"profile_id","value":"A00457","description":"The unique identifier for the profile that is set upon profile creation or update."},{"key":"email","value":"john.doe@example.com","description":"The email address for the profile."},{"key":"event","value":"unsubscribe","description":"The subscription event that took place. Supported events: subscribe, unsubscribe."},{"key":"newsletter_id","value":"6","description":"The newsletter ID to which the profile subscribed to or unsubscribed from."},{"key":"time","value":"2022-01-01 00:00:00 -0400","description":"The date and time at which the subscription event occurred."}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"5a02e00d-4ebc-4ede-a9b2-44819417ba48","name":"Subscribe event with field aliases","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml","type":"text"}],"url":{"raw":"https://example.com/webhooks?pid=A00001&email=jane.doe@example.com&event=subscribe&nid=2&time=2022-01-01 00:00:00 -0400","protocol":"https","host":["example","com"],"path":["webhooks"],"query":[{"key":"pid","value":"A00001","description":"The unique identifier for the profile that is set upon profile creation or update."},{"key":"email","value":"jane.doe@example.com","description":"The email address for the profile."},{"key":"event","value":"subscribe","description":"The subscription event that took place. Supported events: subscribe, unsubscribe."},{"key":"nid","value":"2","description":"The newsletter ID to which the profile subscribed to or unsubscribed from."},{"key":"time","value":"2022-01-01 00:00:00 -0400","description":"The date and time at which the subscription event occurred."}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"5f436ab9-6059-4f28-a488-d4e2c86c4aff","name":"Unsubscribe event with field aliases","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml","type":"text"}],"url":{"raw":"https://example.com/webhooks?pid=A00457&email=john.doe@example.com&event=unsubscribe&nid=6&time=2022-01-01 00:00:00 -0400","protocol":"https","host":["example","com"],"path":["webhooks"],"query":[{"key":"pid","value":"A00457","description":"The unique identifier for the profile that is set upon profile creation or update."},{"key":"email","value":"john.doe@example.com","description":"The email address for the profile."},{"key":"event","value":"unsubscribe","description":"The subscription event that took place. Supported events: subscribe, unsubscribe."},{"key":"nid","value":"6","description":"The newsletter ID to which the profile subscribed to or unsubscribed from."},{"key":"time","value":"2022-01-01 00:00:00 -0400","description":"The date and time at which the subscription event occurred."}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"82d705b7-58e2-4b4a-892a-7f32c6ad6586"},{"name":"Subscription webhooks (data sent in request body)","id":"51ba5c2c-008c-4e06-b767-f387f32702b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"profile_id\": \"{{profile-id}}\",\r\n \"email\": \"{{email}}\",\r\n \"event\": \"{{event}}\",\r\n \"newsletter_id\": {{newsletter-id}}\r\n \"time\": \"{{datestamp}}\",\r\n}","options":{"raw":{"language":"json"}}},"url":"{{your-webhook-listener-url}}","description":"StartFragment
\nWebhooks sent using the POST method provide data as a JSON object in the request body.
EndFragment
\n","urlObject":{"host":["{{your-webhook-listener-url}}"],"query":[],"variable":[]}},"response":[{"id":"6869db16-0eeb-45a4-9451-d2ad26d63a0c","name":"Subscribe event","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"profile_id\": \"A00001\",\r\n \"email\": \"jane.doe@example.com\",\r\n \"event\": \"subscribe\",\r\n \"newsletter_id\": 2,\r\n \"time\": \"2022-01-01 00:00:00 -0400\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://example.com/webhooks"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"8a764256-47f7-4333-bf63-064b30c373e5","name":"Unubscribe event","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"profile_id\": \"A00457\",\r\n \"email\": \"john.doe@example.com\",\r\n \"event\": \"unsubscribe\",\r\n \"newsletter_id\": 6,\r\n \"time\": \"2022-01-01 00:00:00 -0400\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://example.com/webhooks"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"30631848-c952-403a-aa8e-6e6003ce81ec","name":"Subscribe event with field aliases","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pid\": \"A00001\",\r\n \"email\": \"jane.doe@example.com\",\r\n \"event\": \"subscribe\",\r\n \"nid\": 2,\r\n \"time\": \"2022-01-01 00:00:00 -0400\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://example.com/webhooks"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"3814295d-929b-4bda-a3d0-dd04f684967a","name":"Unubscribe event with field aliases","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/xml","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pid\": \"A00457\",\r\n \"email\": \"john.doe@example.com\",\r\n \"event\": \"unsubscribe\",\r\n \"nid\": 6,\r\n \"time\": \"2022-01-01 00:00:00 -0400\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://example.com/webhooks"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"f9c039cd-e12c-46ac-80e5-fd90c937f5d2","name":"Subscription webhook with Custom Header","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{key-value}}","type":"text"}],"url":{"raw":"webhooks.upaknee.com","host":["webhooks","upaknee","com"],"query":[{"key":"","value":"","type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"event\": \"subscribe\",\n \"time\": \"2020-01-01%2000%3A00%3A00%00-0400\",\n \"profile_id\": \"345987\",\n \"email\": \"email@example.com\",\n \"newsletter_id\": 1\n}"},{"id":"4ef0290a-3e66-42f7-abe7-b4dd94fc9d6e","name":"Subscription webhook with Correlation-ID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{key-value}}","type":"text","disabled":true},{"key":"X-Correlation-ID","value":"{{request-unique-id}}","type":"text"}],"url":{"raw":"webhooks.upaknee.com","host":["webhooks","upaknee","com"],"query":[{"key":"","value":"","type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"event\": \"subscribe\",\n \"time\": \"2020-01-01%2000%3A00%3A00%00-0400\",\n \"profile_id\": \"345987\",\n \"email\": \"email@example.com\",\n \"newsletter_id\": 1\n}"}],"_postman_id":"51ba5c2c-008c-4e06-b767-f387f32702b0"}],"id":"d511ad0a-160b-409d-b5ef-69b3a2fc9e53","description":"Webhooks are currently supported by the Enterprise REST API for subscription status changes only. A single webhook listener URL is used for all newsletters, and enabling outbound subscription webhooks will instruct the application to send webhooks for all newsletters and status changes; this cannot be currently be changed.
\nProvided that subscription webhooks are enabled on your account, When a profile is successfully subscribed to or unsubscribed from a newsletter, the application will send a webhook to the configured webhook listener URL; both POST and GET methods are available.
The Enterprise REST API supports subscription webhooks that are fired when a subscription is first created for a profile or when a subscription's status changes.
\nPlease note that the following is not currently configurable:
\n* A single webhook listener URL is used per account.
* The configured events for all newsletters are sent.
Alias(es)
\nWhile the number of parameters provided in the webhook cannot change, you may opt to use alias for the newsletter_id and profile_id parameters. When an alias is configured for either or both parameters, the outbound webhook will replace the respective parameter with the supplied alias. For example, you may use the alias nid instead of newsletter_id.
Custom Headers
\nIt is also possible to specify additional headers that should be submitted in the webhook response, e.g. if the configured endpoint requires a 'subscription-key' or other authenticated information within the header, these can be configured when setting up the subscription webhook. If you require these additional configurations, please specify the header-key and header-value in your support ticket request.
\nSetting up a webhook
\nSubscription webhooks are disabled by default. Contact Upaknee Support at support@upaknee.com if you would like them enabled.
\nWhen submitting a ticket, please provide:
\n* Your webhook listener URL
* The alias(es) for newsletter ID and profile ID, if applicable