Download OpenAPI specification:Download
GetResponse API calls are subject to throttling to ensure a high level of service for all users.
Time frame is a period of time for which we calculate the API call limits. The limits reset in every time frame.
The time frame duration is 10 minutes.
Each user is allowed to make 30,000 API calls per time frame (10 minutes) and 80 API calls per second.
It is possible to send up to 10 simultaneous requests.
Every API response includes a few additional headers:
X-RateLimit-Limit
– the total number of requests available per time frameX-RateLimit-Remaining
– the number of requests left in the current time frameX-RateLimit-Reset
– seconds left in the current time frameThe 429 Too Many Requests HTTP response code indicates that the limit has been reached. The error response includes currentLimit
and timeToReset
fields in the context section, with the total number of requests available per time frame and seconds left in the current time frame respectively.
When you reach the limit, you need to wait for the time specified in timeToReset
field or X-RateLimit-Reset
header before making another request.
API can be accessed by authenticated users only. This means that every request must be signed with your credentials. We offer two methods of authentication: API Key and OAuth 2.0. API key is our primary method and should be used in most cases. GetResponse MAX clients have to send an X-Domain
header in addition to the API key. Supported OAuth 2.0 flows are: Authorization Code, Client Credentials, Implicit, and Refresh Token.
Follow these steps to send an authentication request:
X-Auth-Token
header to all your requests. For example, if your API key is jfgs8jh4ksg93ban9Dfgh8
, the header will look like this:X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8
For security reasons, unused API keys expire after 90 days. When that happens, you’ll need to generate a new key to use our API.
$ curl -H "X-Auth-Token: api-key jfgs8jh4ksg93ban9Dfgh8" https://api.getresponse.com/v3/accounts
To use OAuth 2.0 authentication, you need to get an "Access Token". For more information on how to obtain a token, head to our dedicated page: OAuth 2.0
To authenticate a request using an Access Token, set the value of Authorization
header to "Bearer" followed by the Access Token.
If the Access Token is jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8
Authorization: Bearer jfg93baDfgh8n9Ds8jh4ksg93ban9Dfgh8
GetResponse MAX customers need to take an extra step to authenticate the request. All requests have to be send with an X-Domain
header that contains the client's domain. For example:
X-Domain: example.com
Please note that the header must contain only the domain name, without the protocol identifier (http://
or https://
).
If you want to use an OAuth flow to authorize your application, first register your application
You need to provide a name, short description, and redirect URL.
Once your application is registered, you can click on it to see your client_id
and client_secret
. They're basically a login and password for your application's access, so be sure not to share them with anyone.
Next, decide which authentication flow (grant type) you want to use. Here are your options:
First, your application must redirect a resource owner to the following URL:
https://app.getresponse.com/oauth2_authorize.html?response_type=code&client_id=_your_client_id_&state=xyz
The state
parameter is there for security reasons and should be a random string. When the resource owner grants your application access to the resource, we will redirect the browser to the redirect URL
you specified in the application settings and attach the same state as the parameter. Comparing the state parameter value ensures that the redirect was initiated by our system. The code parameter is an authorization code that you can exchange for an access token within 10 minutes, after which time it expires.
https://myredirecturi.com/cb?code=ed17c498bfe343175cd7684c5b09979f2875b25c&state=xyz
Here's an example request to exchange authorization code for the access token:
$ curl -u client_id:client_secret https://api.getresponse.com/v3/token \
-d 'grant_type=authorization_code&code=ed17c498bfe343175cd7684c5b09979f2875b25c'
Remember to replace client_id
and client_secret
with your OAuth application credentials.
{
"access_token": "03807cb390319329bdf6c777d4dfae9c0d3b3c35",
"expires_in": 3600,
"token_type": "Bearer",
"scope": null,
"refresh_token": "170d9f64e781aaa6b3ba036083faba71b2fc4e6c"
}
This flow is suitable for development, when you need to quickly access API to create some functionality. You can get the access token with a single request:
$ curl -u client_id:client_secret https://api.getresponse.com/v3/token \
-d 'grant_type=client_credentials'
Remember to replace client_id
and client_secret
with your OAuth application credentials.
{
"access_token": "e2222af2851a912470ec33c9b4de1ea3a304b7d7",
"expires_in": 86400,
"token_type": "Bearer",
"scope": null
}
You can also go to https://app.getresponse.com/manage_api.html, click the action button for your application, and select "generate credentials". This will open a popup with a generated access token. You can then use the access token to authenticate your requests, for example:
$ curl -H "Authorization: Bearer e2222af2851a912470ec33c9b4de1ea3a304b7d7" https://api.getresponse.com/v3/from-fields
First, your application must redirect a resource owner to the following URL:
https://app.getresponse.com/oauth2_authorize.html?response_type=token&client_id=_your_client_id_&redirect_uri=https://myredirecturi.com/cb&state=xyz
When the resource owner grants your application access to the resource, we will redirect the owner to the URL that was specified in the request.
There is no code exchange process because, unlike the Authorization Code flow, the redirect already has the access token in the parameters.
https://myredirecturi.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA&state=xyz&token_type=bearer&expires_in=3600
You need to refresh your access token if you receive this error message as a response to your request:
{
"httpStatus": 401,
"code": 1014,
"codeDescription": "Problem during authentication process, check headers!",
"message": "The access token provided is expired",
"moreInfo": "https://apidocs.getresponse.com/v3/errors/1014",
"context": {
"sentToken": "b8b1e961a7f9fd4cc710d5d955e09c15a364ab71"
}
}
If you are using the Authorization Code flow, you need to use the refresh token to issue a new access token/refresh token pair by making the following request:
$ curl -u client_id:client_secret https://api.getresponse.com/v3/token \
-d 'grant_type=refresh_token&refresh_token=170d9f64e781aaa6b3ba036083faba71b2fc4e6c'
Remember to replace client_id
and client_secret
with your OAuth application credentials.
The response you'll get will look like this:
{
"access_token": "890fdsa2f5d7b189fc4e6c4b1d170d9f591238ss",
"expires_in": 86400,
"token_type": "Bearer",
"scope": null,
"refresh_token": "170d9f64e781aaa6b3ba036083faba71b2fc4e6c"
}
There are some differences when authenticating GetResponse MAX users:
https://custom-domain.getresponse360.com/oauth2_authorize.html
X-Domain
header,Cross-Origin Resource Sharing (CORS) mechanism is not supported by APIv3. It means that AJAX requests to the API will be blocked by the browser's same-origin policy. Please use a server-side application to access the API.
The default timezone in response data is UTC.
To set a different timezone, add X-Time-Zone
header with value of time zone name ("TZ database name" column).
Most of the resource collections returned by API are paginated. It means that the response is divided into multiple pages.
Control the number of results on each page by using perPage
query parameter and change pages by using page
query parameter.
By default we return only the first 100 resources per page. You can change that by adding perPage
parameter with a value of up to 1000.
Page numbers start with 1.
Paginated responses have 3 extra headers:
TotalCount
– a total number of resources on all pagesTotalPages
– a total number of pagesCurrentPage
– current page numberUse the maximum perPage
value (1000) if you plan to iterate over all the pages of the response.
When trying to get a page that exceeds the total number of pages, API will return an empty array ([]
). Make sure to stop iterating when it happens.
Solution to CURLE_SSL_CACERT error (code 60).
This error is related to expired CA (Certificate Authority) certificates installed on your server (the server that you send the requests from). You can read more about certificate verification on the cURL project website.
If you encounter this error while sending requests to the GetResponse APIv3, ask your server administrator to update the CA certificates using the latest bundle provided by the cURL project.
Please make sure that cURL is configured to use the updated bundle.
Header value must be prefixed with api-key
Security scheme type: | API Key |
---|---|
header parameter name: | X-Auth-Token |
Security scheme type: | OAuth2 |
---|---|
implicit OAuth Flow | Authorization URL: https://app.getresponse.com/oauth2_authorize.html Scopes:
|
authorizationCode OAuth Flow | Authorization URL: https://app.getresponse.com/oauth2_authorize.html Token URL: https://api.getresponse.com/v3/token Scopes:
|
clientCredentials OAuth Flow | Token URL: https://api.getresponse.com/v3/token Scopes:
|
Authorizations: | api-keyoauth2 (all ) |
query[mask] | string Example: "@somedomain.com" Blocklist mask to search for |
Blocklist masks for the whole account.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
additionalFlags | string Enum:"add" "delete" "noResponse" The flag value For better performance, use the flag value |
masks required | Array of string |
Blocklist masks for the whole account.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
Your account information
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
firstName | string [ 2 .. 64 ] characters First name |
lastName | string [ 2 .. 64 ] characters Last name |
companyName | string [ 2 .. 64 ] characters Company name |
phone | string [ 2 .. 32 ] characters Phone number |
state | string [ 2 .. 40 ] characters State |
city | string City |
street | string [ 2 .. 64 ] characters Street |
zipCode | string [ 2 .. 9 ] characters ZIP Code |
numberOfEmployees | string Enum:"50" "250" "500" "more" Numbers of employees |
timeFormat | string Enum:"12h" "24h" Account time notation |
Your account information
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
Billing information.
Request validation error
Authentication error
The throttling limit has been reached
List of timezones in account's language context.
Authorizations: | api-keyoauth2 (all ) |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
List of time zones
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
Callback configuration
Request validation error
Authentication error
Callbacks are disabled for the account
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
url | string <uri> URL to use to post notifications, required if callbacks are not yet enabled |
actions | object (CallbackActions) |
Callback configuration
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
Empty response
Request validation error
Authentication error
The throttling limit has been reached
List of Industry Tags in account's language context.
Authorizations: | api-keyoauth2 (all ) |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
Industry tags list
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
Login history information
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
Account badge status
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
status required | string (StatusEnum) Enum:"enabled" "disabled" |
Account badge status
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
Send limits
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
Image list
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
file | string <binary> |
Image details
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
fileId required | string Example: "6Yh" The file ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The file details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
fileId required | string Example: "6Yh" The file ID |
Delete file
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
folderId required | string Example: "Pa5" The folder ID |
Delete folder
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
Storage space information
Request validation error
Authentication error
The throttling limit has been reached
By default, you can only search files in the root directory. To search for files in all folders, use the parameter query[allFolders]=true
. To search for files in a specified folder, use the parameter query[folderId]=<folderId>
. Note: these two parameters can't be used together. You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[allFolders] | string (StringBooleanEnum) Enum:"true" "false" Return files from all folders, including the root folder. This parameter can't be used together with |
query[folderId] | string Search for files in a specific folder. This parameter can't be used together with |
query[name] | string Search for files by name |
query[group] | string (FileGroup) Enum:"audio" "video" "photo" "document" Example: "photo" Search for files by group |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by name |
sort[group] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort files by group |
sort[size] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort files by size |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of files
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
content required | string <byte> The base64 encoded file content |
name required | string [ 1 .. 255 ] characters The file name |
extension required | string The file extension |
folder required | object (FolderShort) Nullable The folder where the file is stored |
The file details
Request validation error
Authentication error
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search folders by name |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort folders by name |
sort[size] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort folders by size |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort folders by creation date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of folders
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
name required | string [ 1 .. 128 ] characters The folder name |
The folder details
Request validation error
Authentication error
Conflict
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
campaignId required | string Example: "3Va2e" The campaign ID |
query[mask] | string Example: "@somedomain.com" Blocklist mask to search for |
Blocklist masks for the campaign.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
campaignId required | string Example: "3Va2e" The campaign ID |
additionalFlags | string Enum:"add" "delete" "noResponse" The flag value For better performance, use the flag value |
masks required | Array of string |
Blocklist masks for the campaign.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
campaignId required | string Example: "3Va2e" The campaign ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The campaign data.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
campaignId required | string Example: "3Va2e" The campaign ID |
name required | string [ 3 .. 64 ] characters The campaign (list) name.
|
languageCode | string The campaign language code according to ISO 639-1, plus: zt - Chinese (Traditional), fs - Afghan Persian (Dari), md - Moldavian |
isDefault | string (StringBooleanEnum) Enum:"true" "false" Is the campaign default |
postal | object (CampaignPostal) |
confirmation | object (CampaignConfirmation) |
optinTypes | object (CampaignOptinTypes) |
subscriptionNotifications | object (CampaignSubscriptionNotifications) |
profile | object (CampaignProfile) |
The campaign data.
Request validation error
Authentication error
Resource not found
Conflict
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Example: "campaign_name" |
query[isDefault] | boolean Example: true |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by name |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of campaigns.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
name required | string [ 3 .. 64 ] characters The campaign (list) name.
|
languageCode | string The campaign language code according to ISO 639-1, plus: zt - Chinese (Traditional), fs - Afghan Persian (Dari), md - Moldavian |
isDefault | string (StringBooleanEnum) Enum:"true" "false" Is the campaign default |
postal | object (CampaignPostal) |
confirmation | object (CampaignConfirmation) |
optinTypes | object (CampaignOptinTypes) |
subscriptionNotifications | object (CampaignSubscriptionNotifications) |
profile | object (CampaignProfile) |
The campaign data.
Request validation error
Authentication error
Conflict
The throttling limit has been reached
The results are indexed with the campaign ID.
Authorizations: | api-keyoauth2 (all ) |
query[campaignId] required | string (CampaignStatisticsIdQuery) Example: "3Va2e" |
query[groupBy] | string Enum:"hour" "day" "month" "total" Example: "month" |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" |
The list of origins.
Request validation error
Authentication error
The throttling limit has been reached
The results are indexed with the location name (PL, EN, etc.).
Authorizations: | api-keyoauth2 (all ) |
query[campaignId] required | string (CampaignStatisticsIdQuery) Example: "3Va2e" |
query[groupBy] | string Enum:"hour" "day" "month" "total" Example: "month" |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" |
The list of locations.
Request validation error
Authentication error
The throttling limit has been reached
Returns the number of the total added and removed subscribers, grouped by default or by time period.
Authorizations: | api-keyoauth2 (all ) |
query[campaignId] required | string (CampaignStatisticsIdQuery) Example: "3Va2e" |
query[groupBy] | string Enum:"hour" "day" "month" "total" Example: "month" |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" |
The campaign data.
Request validation error
Authentication error
The throttling limit has been reached
Returns the number and origin of subscriptions, grouped by a specified campaigns for each day on which any changes were made. Dates in the YYYY-MM-DD format are used as keys in the response.
Authorizations: | api-keyoauth2 (all ) |
query[campaignId] required | string (CampaignStatisticsIdQuery) Example: "3Va2e" |
query[groupBy] | string Enum:"hour" "day" "month" "total" Example: "month" |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" |
Subscription statistics by date
Request validation error
Authentication error
The throttling limit has been reached
Returns the number and reason for removed contacts. Dates in the YYYY-MM-DD format are used as keys in the response.
Authorizations: | api-keyoauth2 (all ) |
query[campaignId] required | string (CampaignStatisticsIdQuery) Example: "3Va2e" |
query[groupBy] | string Enum:"hour" "day" "month" "total" Example: "month" |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" |
Subscription statistics by date
Request validation error
Authentication error
The throttling limit has been reached
Returns the balance of subscriptions. Dates in the YYYY-MM-DD format are used as keys in the response.
Authorizations: | api-keyoauth2 (all ) |
query[campaignId] required | string (CampaignStatisticsIdQuery) Example: "3Va2e" |
query[groupBy] | string Enum:"hour" "day" "month" "total" Example: "month" |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" |
The subscription statistics, shown by date.
Request validation error
Authentication error
The throttling limit has been reached
The results are indexed with the campaign ID.
Authorizations: | api-keyoauth2 (all ) |
query[campaignId] | string (CampaignStatisticsIdQuery) Example: "3Va2e" |
The summary list.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
contactId required | string Example: "pV3r" The contact ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The contact details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Skip the fields you don't want to update. If tags and custom fields are provided, they'll be replaced with the values sent in this request. If the campaignId
changes, the contact will be moved from the original campaign (list) to the new campaign (list). Their activity history and statistics will also be moved.
Authorizations: | api-keyoauth2 (all ) |
contactId required | string Example: "pV3r" The contact ID |
name | string [ 1 .. 128 ] characters |
campaign | object (CampaignReference) |
email required | string <email> |
dayOfCycle | string Nullable The day on which the contact is in the Autoresponder cycle. |
scoring | number Nullable Contact scoring, pass null to remove the score from a contact |
note | string [ 0 .. 255 ] characters Nullable |
tags | Array of object (NewContactTag) |
customFieldValues | Array of object (NewContactCustomFieldValue) |
The contact details.
Request validation error
Authentication error
Resource not found
Conflict
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
contactId required | string Example: "pV3r" The contact ID |
messageId | string The ID of a message (such as a newsletter, an autoresponder, or an RSS-newsletter). When passed, this method will simulate the unsubscribe process, as if the contact clicked the unsubscribe link in a given message. |
ipAddress | string <ipv4> This makes it possible to pass the IP from which the contact unsubscribed. Used only if the |
Empty response.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
By default, only activities from the last 14 days are returned. To get earlier data, use query[createdOn]
parameter. You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
contactId required | string Example: "pV3r" The contact ID |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of contact activities.
Request validation error
Authentication error
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
campaignId required | string Example: "3Va2e" The campaign ID |
query[email] | string Search contacts by email |
query[name] | string Search contacts by name |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data to this date |
sort[email] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort contacts by email |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort contacts by name |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort contacts by creation date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of contacts.
Request validation error
Authentication error
The throttling limit has been reached
Upsert (add or update) the custom fields of a contact. This method doesn't remove (unassign) custom fields.
Authorizations: | api-keyoauth2 (all ) |
contactId required | string Example: "pV3r" The contact ID |
customFieldValues required | Array of object (NewContactCustomFieldValue) |
The list of custom fields
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Upsert (add or update) the tags of a contact. This method doesn't remove (unassign) tags.
Authorizations: | api-keyoauth2 (all ) |
contactId required | string Example: "pV3r" The contact ID |
tags required | Array of object (NewContactTag) |
The list of contact tags.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[email] | string Search contacts by email |
query[name] | string Search contacts by name |
query[campaignId] | string Search contacts by campaign ID |
query[origin] | string Enum:"import" "email" "www" "panel" "leads" "sale" "api" "survey" "iphone" "copy" "landing_page" "webinar" "website_builder_elegant" "chat" "course" "premium_newsletter" Search contacts by origin |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data to this date |
query[changedOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search contacts edited from this date |
query[changedOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search contacts edited to this date |
sort[email] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by email |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by name |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
sort[changedOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by change date |
sort[campaignId] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by campaign ID |
additionalFlags | string The additional flags parameter with the value 'exactMatch' will search for contacts with the exact value of the email and name provided in the query string. Without this flag, matching is done via a standard 'like' comparison, which may sometimes be slow. |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of contacts.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
name | string [ 1 .. 128 ] characters |
campaign required | object (CampaignReference) |
email required | string <email> |
dayOfCycle | string Nullable The day on which the contact is in the Autoresponder cycle. |
scoring | number Nullable Contact scoring, pass null to remove the score from a contact |
ipAddress | string <ipv4> or string <ipv6> The contact's IP address. IPv4 and IPv6 formats are accepted. |
tags | Array of object (NewContactTag) |
customFieldValues | Array of object (NewContactCustomFieldValue) |
If the request is successful, the API returns the HTTP code 202 Accepted. This means that the contact has been preliminarily validated and added to the queue. It may take a few minutes to process the queue and add the contact to the list. If your contact didn't appear on the list, there's a possibility that it was rejected at a later stage of processing.
Campaigns can be set to double opt-in. This means that the contact has to click a link in a confirmation message before they can be added to your list. Unconfirmed contacts are not returned by the API and can only be found using Search Contacts.
Request validation error
Authentication error
Conflict
The throttling limit has been reached
This endpoint lets you create multiple contacts in one request.
Note
This endpoint is subject to special limits and throttling. You can make 80 calls per time frame (10 minutes) and only 1 call per second. The allowed batch size is 1000 contacts. For more information, check our API Docs.
Authorizations: | api-keyoauth2 (all ) |
campaignId required | string ID of the destination campaign (list). |
contacts required | Array of object Contacts that will be created. |
If the request is successful, the API returns the HTTP code 202 Accepted. This means that the contacts has been preliminarily validated and added to the queue. It may take a few minutes to process the queue and add the contacts to the list. If your contact doesn't appear on the list, they were likely rejected during the late processing stages.
Campaigns (lists) can be set to use double opt-in. This means that a contact has to click a link in a confirmation message before they can be added to your list. Unconfirmed contacts are not returned by API and can only be found using Search Contacts.
Request validation error
Authentication error
Conflict
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
customFieldId required | string Example: "pas" The custom field ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The custom field details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
customFieldId required | string Example: "pas" The custom field ID |
hidden required | string (StringBooleanEnum) Enum:"true" "false" Whether the custom field is visible to contacts |
values required | Array of string The list of assigned values (zero or more - depending on the custom field type. Please see description) |
The custom field details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
customFieldId required | string Example: "pas" The custom field ID |
Delete a custom field.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search custom fields by name |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by name |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of custom fields
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
name required | string [ 1 .. 128 ] characters The name of the custom field. It must meet the following requirements:
|
type required | string (CustomFieldTypeEnum) Enum:"string" "number" "date" "datetime" "country" "currency" "phone" "gender" "ip" "url" The custom field
|
format required | string (CustomFieldFormatEnum) Enum:"text" "textarea" "radio" "checkbox" "single_select" "multi_select" The custom field
|
hidden required | string (StringBooleanEnum) Enum:"true" "false" Whether the custom field is visible to contacts |
values required | Array of string The list of assigned default values, starting from zero depending on the custom field format. (Please see description). |
The custom field details.
Request validation error
Authentication error
The throttling limit has been reached
Get the definition of a specific contact-search filter.
Authorizations: | api-keyoauth2 (all ) |
searchContactId required | string Example: "pV3r" The saved search contact identifier |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
Search contact details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Update specified search contacts.
Authorizations: | api-keyoauth2 (all ) |
searchContactId required | string Example: "pV3r" The saved search contact identifier |
subscribersType | Array of string Default: "subscribed" Items Value:"subscribed" Only one subscription status |
sectionLogicOperator required | string Enum:"or" "and" Match 'any' ( |
section required | Array of object (SearchContactSection) |
name required | string The unique name of search-contact |
Search contact details.
Request validation error
Authentication error
Resource not found
Conflict
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
searchContactId required | string Example: "pV3r" The saved search contact identifier |
Delete search contacts.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Get contacts from saved search contacts by ID.
Authorizations: | api-keyoauth2 (all ) |
searchContactId required | string Example: "pV3r" The saved search contact identifier |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Example: "desc" Sort by name |
sort[email] | string (SortOrderEnum) Enum:"ASC" "DESC" Example: "desc" Sort by email |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Example: "asc" Sort by creation date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The contact list.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Makes it possible to add and update custom field values for all contacts that meet the search criteria. This method doesn't remove or overwrite custom fields with the values from the request.
Authorizations: | api-keyoauth2 (all ) |
searchContactId required | string Example: "pV3r" The saved search contact identifier |
customFieldValues required | Array of object (NewContactCustomFieldValue) |
Upsert custom fields by searchContactId.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Makes it possible to retrieve a collection of short representations of search-contact (known as custom filters in the panel). Every item represents a basic filter object. You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Example: "desc" Sort by name |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Example: "asc" Sort by creation date |
query[name] | string Search by name |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data to this date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The saved search contact.
Request validation error
Authentication error
The throttling limit has been reached
Makes it possible to create a new search-contact. Please refer to Segments (search contacts) reference manual
Authorizations: | api-keyoauth2 (all ) |
subscribersType | Array of string Default: "subscribed" Items Value:"subscribed" Only one subscription status |
sectionLogicOperator required | string Enum:"or" "and" Match 'any' ( |
section required | Array of object (SearchContactSection) |
name required | string The unique name of search-contact |
Search contact details.
Request validation error
Authentication error
Conflict
The throttling limit has been reached
Makes it possible to get a collection of contacts according to a given condition. Please refer to Segments (search contacts) reference manual
Authorizations: | api-keyoauth2 (all ) |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Example: "desc" Sort by name |
sort[email] | string (SortOrderEnum) Enum:"ASC" "DESC" Example: "desc" Sort by email |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Example: "asc" Sort by creation date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
subscribersType required | Array of string Items Enum:"subscribed" "undelivered" "removed" "unconfirmed" Only one subscription status |
sectionLogicOperator required | string Enum:"or" "and" Match 'any' ( |
section required | Array of object (SearchContactSection) |
The contact list.
Request validation error
Authentication error
The throttling limit has been reached
Sending GET request to this url, returns collection of SUBSCRIPTION CONFIRMATIONS bodies.
Language code used in url must be in ISO 639-1 Language Code Standard.
Authorizations: | api-keyoauth2 (all ) |
languageCode required | string Example: "en" ISO 639-1 Language Code Standard |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
List of subscription confirmation bodies
Request validation error
Authentication error
The throttling limit has been reached
Sending GET request to this url, returns collection of SUBSCRIPTION CONFIRMATIONS subjects.
Language code used in url must be in ISO 639-1 Language Code Standard.
Authorizations: | api-keyoauth2 (all ) |
languageCode required | string Example: "en" ISO 639-1 Language Code Standard |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
List of subscription confirmation subjects
Request validation error
Authentication error
The throttling limit has been reached
Get detailed information about a specified predefined field.
Authorizations: | api-keyoauth2 (all ) |
predefinedFieldId required | string Example: "6neM" The predefined field identifier |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The predefined field details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
predefinedFieldId required | string Example: "6neM" The predefined field identifier |
value required | string [ 1 .. 350 ] characters ^[A-Za-z_]{1,350}$ |
The predefined field details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
predefinedFieldId required | string Example: "6neM" The predefined field identifier |
Delete a predefined field.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Example: "DESC" Sort by name |
query[name] | string Search by name |
query[campaignId] | string Search by campaign ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of predefined fields.
Request validation error
Authentication error
The throttling limit has been reached
Makes it possible to create a new predefined field.
Authorizations: | api-keyoauth2 (all ) |
name required | string [ 1 .. 32 ] characters ^[A-Za-z0-9_]{1,32}$ |
value required | string [ 1 .. 350 ] characters |
campaign required | object (CampaignReference) |
The predefined field details.
Request validation error
Authentication error
Conflict
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
suppressionId required | string Example: "pypF" The suppression ID |
The suppression details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
suppressionId required | string Example: "pypF" The suppression ID |
name required | string The name of the suppression list |
masks required | Array of string |
The suppression details.
Request validation error
Authentication error
Resource not found
Conflict
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
suppressionId required | string Example: "pypF" The suppression ID |
Suppression list deleted successfully.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search suppressions by name |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search suppressions created from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search suppressions created to this date |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by name |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by the createdOn date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The suppressions list.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
name required | string The name of the suppression list |
masks | Array of string |
The suppression details.
Request validation error
Authentication error
Conflict
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
importId required | string Example: "o6gE" The import ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The import details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[campaignId] | string Search imports by campaignId |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search imports created from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search imports created to this date |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort imports by creation date |
sort[finishedOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort imports by finish date |
sort[campaignName] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort imports by campaign name |
sort[uploadedContacts] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort imports by uploaded contact count |
sort[updatedContacts] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort imports by updated contact count |
sort[addedContacts] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort imports by inserted contact count |
sort[invalidContacts] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort imports by invalid contact count |
sort[status] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort imports by status (uploaded, to_review, approved, finished, rejected, canceled) |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of imports.
Request validation error
Authentication error
The throttling limit has been reached
This endpoint lets you schedule a contact import. That way, you can add and update your contacts using a single API call. Since API imports are asynchronous, you should check periodically for updates while your original API request is being processed. To keep track of your import status, use GET import (provide the importId from the response), or subscribe to an import finished webhook. Please note, that this endpoint has specific rate limits - for details please refer to Create Import Limits. For more information on imports, check our API Docs or Help Center
Authorizations: | api-keyoauth2 (all ) |
campaignId required | string The ID of the destination campaign (list) |
fieldMapping required | Array of string Mapping definition for such contact properties as email address, name, or custom fields. It's the equivalent of column headers in a CSV file used to import contacts in a GetResponse account. The |
contacts required | Array of Array of string (NewImportContact) Container for a contact definition. Include the values defined in the |
The import details.
Request validation error
Authentication error
Conflict
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
newsletterId required | string Example: "N" The newsletter ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The newsletter details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
newsletterId required | string Example: "N" The newsletter ID |
Delete newsletter.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
By default, activities from the last 14 days are listed only. You can get activities for last 30 days only. You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
newsletterId required | string Example: "N" The newsletter ID |
query[activity] | string Enum:"send" "open" "click" Search newsletter activities by activity type |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search newsletter activities from this date. Default value is 14 days earlier. You can get activities for last 30 days only. |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search newsletter activities to this date. Default value is now |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of newsletters activities
Request validation error
Authentication error
The throttling limit has been reached
Using this method, you can cancel the sending of the newsletter. It will also turn the newsletter into a draft.
Authorizations: | api-keyoauth2 (all ) |
newsletterId required | string Example: "N" The newsletter ID |
The newsletter details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
This makes it possible to easily fetch statistics for a single newsletter. You can group the data hourly, daily, monthly and as a
total sum. Remember that all statistics date ranges are given in standard UTC period type objects.
(See ISO 8601 standard).
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
newsletterId required | string Example: "N" The newsletter ID |
query[groupBy] | string Enum:"total" "hour" "day" "month" Group results by time interval |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data to this date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of autoresponder statistics split by time interval.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
newsletterId required | string Example: "N" The newsletter ID |
size | string Default: "default" Enum:"default" "small" The size of the thumbnail |
The newsletter thumbnail.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[subject] | string Search newsletters by subject |
query[name] | string Search newsletters by name |
query[status] | string Enum:"enabled" "disabled" Search newsletters by status |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search newsletters created from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search newsletters created to this date |
query[sendOn][from] | string <date> Example: "2023-01-20" Search for newsletters sent from this date |
query[sendOn][to] | string <date> Example: "2023-01-20" Search for newsletters sent to this date |
query[type] | string Enum:"draft" "broadcast" "splittest" "automation" Search newsletters by type |
query[campaignId] | string Search newsletters by campaign ID |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
sort[sendOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by send on date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of newsletters.
Request validation error
Authentication error
The throttling limit has been reached
This method creates a new newsletter and puts it in a queue to send.
NOTE: This method has a limit of 256 calls per day.
Authorizations: | api-keyoauth2 (all ) |
content required | object (MessageContent) The message content. |
flags | Array of string (MessageFlagsArray) Items Enum:"openrate" "clicktrack" "google_analytics" The message flags. |
name | string [ 2 .. 128 ] characters The newsletter name |
type | string Default: "broadcast" Enum:"broadcast" "draft" The newsletter type |
editor | string (MessageEditorEnum) Enum:"custom" "text" "getresponse" "legacy" "html2" This describes how the content of the message was created |
subject required | string [ 2 .. 128 ] characters The message subject |
fromField required | object (FromFieldReference) The 'From' email address used for the message |
replyTo | object (FromFieldReference) The email that will be used as the reply-to address |
campaign required | object (CampaignReference) The newsletter must be assigned to a campaign |
attachments | Array of object (NewsletterAttachment) The newsletter attachments. The size of all attachments combined can't exceed 400KB |
sendSettings required | object (NewsletterSendSettingsDetails) How the message will be delivered to the subscriber. You can specify multiple parameters. Then the system uses AND logic. |
The newsletter details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
messageId required | string The message identifier (equals to newsletterId) |
sendSettings required | object (NewsletterSendSettingsDetails) How the message will be delivered to the subscriber |
The newsletter details.
Request validation error
Authentication error
The throttling limit has been reached
This makes it possible to fetch newsletter statistics based on the list of campaign or newsletter IDs (you can pass them in the query parameter - see the description below). Remember that all the statistics date ranges are returned in standard UTC period type objects. (See ISO 8601 standard). You can filter the resource using criteria specified as
query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified assort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[groupBy] | string Enum:"total" "hour" "day" "month" Group results by time interval |
query[newsletterId] | string The list of newsletter resource IDs (string separated with '') |
query[campaignId] | string The list of campaign resource IDs (string separated with '') |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data to this date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of autoresponders statistic split by time interval.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
autoresponderId required | string Example: "Q" The autoresponder ID. |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The autoresponder details'
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
The action-based autoresponder feature has been migrated over to marketing automation. Your existing autoresponders are now converted into workflows. You can no longer create and update action-based autoresponders using our API.
This method allows you to update an autoresponder. The same rules as in creating an autoresponder apply.
Authorizations: | api-keyoauth2 (all ) |
autoresponderId required | string Example: "Q" The autoresponder ID. |
name | string [ 2 .. 128 ] characters The autoresponder name |
subject | string [ 2 .. 128 ] characters The autoresponder message subject |
campaignId | string The campaign ID. The system will assign the autoresponder to a default campaign if you don't provide a specific campaign ID. |
status | string (StatusEnum) Enum:"enabled" "disabled" The autoresponder status |
editor | string (MessageEditorEnum) Enum:"custom" "text" "getresponse" "legacy" "html2" How the message was created: |
fromField | object (FromFieldReference) The from email address used for the message |
replyTo | object (FromFieldReference) The email that will be used as a reply-to address |
content | object (MessageContent) The message content. |
flags | Array of string (MessageFlagsArray) Items Enum:"openrate" "clicktrack" "google_analytics" The message flags. |
sendSettings | object (AutoresponderSendSettings) How the message will be delivered to the subscriber |
triggerSettings | object (AutoresponderTriggerSettings) The conditions that will trigger the autoresponder |
The autoresponder details'
Request validation error
Authentication error
Resource not found
Conflict
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
autoresponderId required | string Example: "Q" The autoresponder ID. |
Delete autoresponder
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
This requst returns the statistics summary for a single given autoresponder. As in all statistics, you can change the date and time range (hourly daily monthly or total). Keep in mind that all statistics date ranges are given in standard UTC period type objects. (See ISO 8601 standard)
(https://app.getresponse.com/statistics.html?t=followup#total).
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
autoresponderId required | string Example: "Q" The autoresponder ID. |
query[groupBy] | string Enum:"total" "hour" "day" "month" Group results by time interval |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data to this date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of autoresponder statistics split by time interval.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
autoresponderId required | string Example: "Q" The autoresponder ID. |
size | string Default: "default" Enum:"default" "small" The size of the autoresponder thumbnail |
The autoresponder thumbnail.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[subject] | string Search autoresponder by subject |
query[name] | string Search autoresponder by name |
query[status] | string Enum:"enabled" "disabled" Search autoresponder by status |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search autoresponder created from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search autoresponder created to this date |
query[campaignId] | string Search autoresponder by campaign ID |
query[type] | string Enum:"timebase" "actionbase" Search autoresponder by type |
query[triggerType] | string Value:"onday" Search autoresponder by triggerType |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by name |
sort[subject] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by subject |
sort[dayOfCycle] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by cycle day |
sort[delivered] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by delivered |
sort[openRate] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by open rate |
sort[clickRate] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by click rate |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of autoresponders.
Request validation error
Authentication error
The throttling limit has been reached
The action-based autoresponder feature has been migrated over to marketing automation. Your existing autoresponders are now converted into workflows. You can no longer create and update action-based autoresponders using our API.
This request allows you to create an autoresponder. Remember to select the proper sendSettings
- depending on type
you need to fill corresponding setting (eg. if you selected type delay
, then you MUST fill delayInHours
field).
Authorizations: | api-keyoauth2 (all ) |
name | string [ 2 .. 128 ] characters The autoresponder name |
subject required | string [ 2 .. 128 ] characters The autoresponder message subject |
campaignId | string The campaign ID. The system will assign the autoresponder to a default campaign if you don't provide a specific campaign ID. |
status required | string (StatusEnum) Enum:"enabled" "disabled" The autoresponder status |
editor | string (MessageEditorEnum) Enum:"custom" "text" "getresponse" "legacy" "html2" How the message was created: |
fromField | object (FromFieldReference) The from email address used for the message |
replyTo | object (FromFieldReference) The email that will be used as a reply-to address |
content required | object (MessageContent) The message content. |
flags | Array of string (MessageFlagsArray) Items Enum:"openrate" "clicktrack" "google_analytics" The message flags. |
sendSettings required | object (AutoresponderSendSettings) How the message will be delivered to the subscriber |
triggerSettings required | object (AutoresponderTriggerSettings) The conditions that will trigger the autoresponder |
The autoresponder details'
Request validation error
Authentication error
Conflict
The throttling limit has been reached
This returns the statistics summary for selected autoresponders. You can select them by specifying the autoresponder or campaign IDs. As in all statistics, you can change the date and time range (hourly daily monthly or total). Keep in mind that all statistics date ranges are given in standard UTC period type objects. (See ISO 8601 standard)
(https://app.getresponse.com/statistics.html?t=followup#total).
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[groupBy] | string Enum:"total" "hour" "day" "month" Group results by time interval |
query[autoreponderId] | string The list of autoresponder resource IDs (string separated with '') |
query[campaignId] | string The list of campaign resource IDs (string separated with '') |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data to this date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of autoresponders statistic split by time interval.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
rssNewsletterId required | string Example: "dGer" The RSS newsletter ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The RSS newsletter details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
rssNewsletterId required | string Example: "dGer" The RSS newsletter ID |
flags | Array of string (MessageFlagsArray) Items Enum:"openrate" "clicktrack" "google_analytics" The message flags. |
rssFeedUrl | string <uri> The URL for the RSS Feed |
subject | string [ 1 .. 255 ] characters The RSS message subject |
name | string [ 1 .. 255 ] characters How your newsletters will be seen inside the application |
status | string (StatusEnum) Enum:"enabled" "disabled" The status of the RSS newsletter |
editor | string (MessageEditorEnum) Enum:"custom" "text" "getresponse" "legacy" "html2" How the message was created: |
fromField | object (FromFieldReference) The 'From' email address used for the message |
replyTo | object (FromFieldReference) The email that will be used as a reply-to address |
content | object (MessageContent) The message content. |
sendSettings | object (RssNewsletterSendSettingsDetails) How the message will be delivered to the subscriber |
The RSS newsletter details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
rssNewsletterId required | string Example: "dGer" The RSS newsletter ID |
Delete RSS newsletter.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
rssNewsletterId required | string Example: "dGer" The RSS newsletter ID |
query[groupBy] | string Enum:"total" "hour" "day" "month" Group results by time interval |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data to this date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of autoresponder statistics split by time interval.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[subject] | string Search RSS newsletters by subject |
query[status] | string Enum:"enabled" "disabled" Search RSS newsletters by status |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search RSS newsletters created from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search RSS newsletters created to this date |
query[campaignId] | string Search RSS newsletters by campaign ID |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of RSS newsletters.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
flags | Array of string (MessageFlagsArray) Items Enum:"openrate" "clicktrack" "google_analytics" The message flags. |
rssFeedUrl required | string <uri> The URL for the RSS Feed |
subject required | string [ 1 .. 255 ] characters The RSS message subject |
name | string [ 1 .. 255 ] characters How your newsletters will be seen inside the application |
status required | string (StatusEnum) Enum:"enabled" "disabled" The status of the RSS newsletter |
editor | string (MessageEditorEnum) Enum:"custom" "text" "getresponse" "legacy" "html2" How the message was created: |
fromField required | object (FromFieldReference) The 'From' email address used for the message |
replyTo | object (FromFieldReference) The email that will be used as a reply-to address |
content required | object (MessageContent) The message content. |
sendSettings required | object (RssNewsletterSendSettingsDetails) How the message will be delivered to the subscriber |
The RSS newsletter details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[groupBy] | string Enum:"total" "hour" "day" "month" Group results by time interval |
query[rssNewsletterId] | string The list of RSS newsletter resource IDs (string separated with ',') |
query[campaignId] | string The list of campaign resource IDs (string separated with ',') |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data to this date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of autoresponders statistic split by time interval.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
landingPageId required | string Example: "avYn" The landing page ID. |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The landing pages details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[domain] | string Search landing pages by domain |
query[status] | string (StatusEnum) Enum:"enabled" "disabled" Search landing pages by status |
query[subdomain] | string Search landing pages by subdomain |
query[metaTitle] | string Search landing pages by metaTitle field |
query[userDomain] | string Search landing pages by user provided domain |
query[campaignId] | string Search landing pages by ID of the assigned campaign. Campaign ID must be encoded! You can get the campaign list with encoded IDs by calling the |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Show landing pages created from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Show landing pages created to this date |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
sort[domain] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by domain |
sort[campaignId] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by campaign |
sort[metaTitle] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by metaTitle |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of landing pages.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
fromFieldId required | string Example: "TTzW" The 'From' address ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The 'From' address details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
fromFieldId required | string Example: "TTzW" The 'From' address ID |
fromFieldIdToReplaceWith | string The 'From' address ID that should replace the deleted 'From' address |
Delete 'From' address.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
fromFieldId required | string Example: "TTzW" The 'From' address ID |
Set a 'From' address as default.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[email] | string Search 'From' address by email |
query[name] | string <date> Search 'From' address by name |
query[isDefault] | boolean Example: true Search only default 'From' address |
query[isActive] | boolean Example: true Search only active 'From' addresses |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort 'From' address by date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of 'From' email addresses ('from fields').
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
email required | string <email> The email address |
name required | string [ 2 .. 64 ] characters The name connected to the email address |
The 'From' address details.
Request validation error
Authentication error
Conflict
The throttling limit has been reached
Get a single A/B test by ID.
Authorizations: | api-keyoauth2 (all ) |
splittestId required | string Example: "9I" The send settings for the A/B test |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
A/B test details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
The list of A/B tests. You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search A/B tests by name |
query[type] | string Search A/B tests by type |
query[status] | string Default: "active" Enum:"active" "inactive" Search A/B tests by status |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search A/B tests created from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search A/B tests created to this date |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by name |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by creation date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of A/B tests.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
abTestId required | string Example: "xyz" A/B test ID |
variantId required | string The message variant ID. A variant identifier from https://apireference.getresponse.com/#operation/getAbtestsSubjectById. |
Choose A/B test winner
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
abTestId required | string Example: "xyz" A/B test ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
A/B test details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
This method allows you to schedule the cancellation of an A/B test. Cancelling an A/B test is an asynchronous operation.
Authorizations: | api-keyoauth2 (all ) |
abTestId required | string Example: "xyz" A/B test ID |
A/B test cancellation scheduled
Request validation error
Authentication error
Resource not found
Conflict
The throttling limit has been reached
This method allows you to delete an A/B test. Deletion is only permitted when the test is in one of the following states: draft
, cancelled
, finished
, or completed
.
Authorizations: | api-keyoauth2 (all ) |
abTestId required | string Example: "xyz" A/B test ID |
A/B test deleted successfully
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search A/B tests by name |
query[stage] | string Enum:"preparing" "testing" "finished" "sending-winner" "cancelled" "draft" "completed" Search A/B tests by stage |
query[abTestId] | string Search A/B tests by ID. You can search for multiple A/B tests using comma-separated values, for example, |
query[campaignId] | string Search A/B tests by list ID. You can search for multiple A/B tests using comma-separated list IDs, for example, |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by name |
sort[stage] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by stage |
sort[sendOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by send date |
sort[totalDelivered] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by total delivered |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of A/B tests
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
name required | string [ 1 .. 100 ] characters A/B test name |
campaign required | object (CampaignReference) |
fromField required | object (FromFieldReference) |
replyTo | object (FromFieldReference) |
deliverySettings required | object The A/B test delivery settings |
flags | Array of string Items Enum:"clicktrack" "google_analytics" "ecommerce_tracking" |
variants required | Array of object Message variants. Please note, the number of subject variants should be between 2 and 5 |
sendSettings required | object The send settings for the A/B test |
content required | object (MessageContent) The message content. |
A/B test details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
clickTrackId required | string Example: "C12t" |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The click track details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search click tracks from messages created from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search click tracks from messages created to this date |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by message date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of click tracks
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
tagId required | string The tag ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The tag details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Updating the tag is not allowed. The method currently performs no update actions and only returns the current tag details.
Authorizations: | api-keyoauth2 (all ) |
tagId required | string Example: "vBd5" The tag ID |
name required | string [ 2 .. 64 ] characters ^[_a-zA-Z0-9]{2,64}$ The tag name |
The tag details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
tagId required | string Example: "vBd5" The tag ID |
Tag deleted successfully.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search tags by name |
query[createdAt][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search tags created from this date |
query[createdAt][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search tags created to this date |
sort[createdAt] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort tags by creation date |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by name |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of tags
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
name required | string [ 2 .. 64 ] characters ^[_a-zA-Z0-9]{2,64}$ The tag name |
The tag details.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
gdprFieldId required | string Example: "MtY" The GDPR field ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The details of the GDPR field
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort fields by name |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort fields by creation date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of GDPR fields
Request validation error
Authentication error
The throttling limit has been reached
Get Legacy Form by ID.
Authorizations: | api-keyoauth2 (all ) |
webformId required | string Example: "3Va2e" The webform (Legacy Form) ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The Legacy Form.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Get the list of Legacy Forms. You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search Legacy Forms by name |
query[modifiedOn][from] | string <date-time> Search Legacy Forms modified from this date |
query[modifiedOn][to] | string <date-time> Search Legacy Forms modified to this date |
query[campaignId] | string Search Legacy Forms by campaignId. Accepts multiple IDs separated with a comma |
sort[modifiedOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort Legacy Forms by modification date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of Legacy Forms.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
formId required | string Example: "pL4e" The form ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The form details.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
formId required | string Example: "pL4e" The form ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The list of form variants.
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search forms by name |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search forms created from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search forms created to this date |
query[campaignId] | string Search forms assigned to this list (campaign). You can pass multiple comma-separated values, eg. |
query[status] | string Enum:"enabled" "disabled" "published" "unpublished" "draft" Search by status. Note: |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" |
sort[visitors] | string (SortOrderEnum) Enum:"ASC" "DESC" |
sort[uniqueVisitors] | string (SortOrderEnum) Enum:"ASC" "DESC" |
sort[subscribed] | string (SortOrderEnum) Enum:"ASC" "DESC" |
sort[subscriptionRate] | string (SortOrderEnum) Enum:"ASC" "DESC" |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of forms.
Request validation error
Authentication error
The throttling limit has been reached
Get a single workflow by ID.
Authorizations: | api-keyoauth2 (all ) |
workflowId required | string Example: "3Va2e" The workflow ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The workflow
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Update single workflow.
Authorizations: | api-keyoauth2 (all ) |
workflowId required | string Example: "3Va2e" The workflow ID |
status required | string Enum:"active" "inactive" "incomplete" An 'incomplete' status means that the workflow is a 'draft' in the web panel |
The workflow
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Get the list of workflows.
Authorizations: | api-keyoauth2 (all ) |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of workflows
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
customEventId required | string Example: "hp2" The custom event ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The custom event details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
customEventId required | string Example: "hp2" The custom event ID |
name required | string^[a-z0-9_]{3,64}$ Unique name of custom event |
attributes required | Array of object (CustomEventAttributeDetails) Optional collection of attributes |
The custom event details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
customEventId required | string Example: "hp2" The custom event ID |
Delete custom event
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search custom events by name |
query[hasAttributes] | string (StringBooleanEnum) Enum:"true" "false" Search custom events with or without attributes |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by name |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of custom events
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
name required | string^[a-z0-9_]{3,64}$ Unique name of custom event |
attributes required | Array of object (CustomEventAttributeDetails) Optional collection of attributes |
The custom event details
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
name required | string [ 3 .. 64 ] characters ^[a-z0-9_]{3,64}$ The name of custom event. Custom event with this name must already exist |
contactId required | string The contact ID |
attributes | Array of object (TriggerCustomEventAttribute) The attributes for the trigger |
Empty response
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
With code snippets you will be able to track Purchases, Abandoned carts, and Visited URLs. Find more in our Help Center.
Authorizations: | api-keyoauth2 (all ) |
The Tracking Snippets
Authentication error
The throttling limit has been reached
Returns the name and ID of "Facebook Pixels" assigned to a user's account.
Authorizations: | api-keyoauth2 (all ) |
"Facebook Pixel" details
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
addressId required | string Example: "k9" The address ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The address details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Update an existing address. You should send only those fields that need to be changed. The rest of the properties will stay the same.
Authorizations: | api-keyoauth2 (all ) |
addressId required | string Example: "k9" The address ID |
countryCode | string 3 characters The country code (ISO 3166-1 alpha-3) |
name | string [ 3 .. 128 ] characters |
firstName | string [ 0 .. 64 ] characters |
lastName | string [ 0 .. 64 ] characters |
address1 | string [ 0 .. 255 ] characters Address line 1 |
address2 | string [ 0 .. 255 ] characters Address line 2 |
city | string [ 0 .. 128 ] characters |
zip | string [ 0 .. 64 ] characters The ZIP/postal code, free text |
province | string [ 0 .. 255 ] characters |
provinceCode | string [ 0 .. 64 ] characters The province code, free text |
phone | string [ 0 .. 255 ] characters The phone number, free text |
company | string [ 0 .. 128 ] characters The company name, free text |
The address details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
addressId required | string Example: "k9" The address ID |
Empty response
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Sending a GET request to this URL returns collection of address resources.
You can narrow down the list of resources by passing proper query parameters (the list of which you can find below in the request params section). You can basically search by:
The name
field can be a pattern and we'll try to match this phrase.
You can specify which page of the results you want and how many results per page to display. You can also specify the sort-order using one or more of the allowed fields (listed below in the request params section).
Last but not least, you can even specify which fields from a resource you want to get. If you pass the param fields
with the list of fields (separated by a comma [,]) we'll return the list of resources with only those fields (we'll always add a resource ID to ensure that you can use that data later on)
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search addresses by name |
query[firstName] | string Search addresses by first name |
query[lastName] | string Search addresses by last name |
query[address1] | string Search addresses by address1 field |
query[address2] | string Search addresses by address2 field |
query[city] | string Search addresses by city |
query[zip] | string Search addresses by ZIP |
query[province] | string Search addresses by province |
query[provinceCode] | string Search addresses by province code |
query[phone] | string Search addresses by phone |
query[company] | string Search addresses by company |
query[createdOn][from] | string <date-time> Search addresses created from this date |
query[createdOn][to] | string <date-time> Search addresses created to this date |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of addresses.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
countryCode required | string 3 characters The country code (ISO 3166-1 alpha-3) |
name required | string [ 3 .. 128 ] characters |
firstName | string [ 0 .. 64 ] characters |
lastName | string [ 0 .. 64 ] characters |
address1 | string [ 0 .. 255 ] characters Address line 1 |
address2 | string [ 0 .. 255 ] characters Address line 2 |
city | string [ 0 .. 128 ] characters |
zip | string [ 0 .. 64 ] characters The ZIP/postal code, free text |
province | string [ 0 .. 255 ] characters |
provinceCode | string [ 0 .. 64 ] characters The province code, free text |
phone | string [ 0 .. 255 ] characters The phone number, free text |
company | string [ 0 .. 128 ] characters The company name, free text |
The address details
Request validation error
Authentication error
The throttling limit has been reached
Sending a GET request to this URL returns a collection of cart resources that belong to the given shop.
You can narrow down the list of resources by passing proper query parameters (the list of which you can find below in the request params section). You can basically search by:
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search carts created from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search carts created to this date |
query[externalId] | string Search cart by external ID |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of carts
Request validation error
Authentication error
The throttling limit has been reached
Sending a POST request to this URL will create a new cart resource.
In order to create a new cart, you need to send the cart resource in the body of the request (remember that you need to serialize the body into a JSON string)
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
contactId required | string The ID of the contact that the cart belongs to. You must first create the contact using POST /v3/contacts, or if it already exists, using GET /v3/contacts |
totalPrice required | number <double> [ 0 .. 999999999999.99 ] The total cart price, tax excluded |
totalTaxPrice | number <double> [ 0 .. 999999999999.99 ] The total cart price, tax included |
currency required | string 3 characters The currency code (ISO 4217) |
selectedVariants required | Array of object (NewCartSelectedProductVariant) |
externalId | string The external ID is the identifying string or number of the cart, given by another software |
cartUrl | string <url> The external cart URL |
The cart details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
This method returns cart with the given cartId
in the context of a given shopId
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
cartId required | string Example: "V" The cart ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The cart details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Update properties of the shop cart. You should send only those fields that need to be changed. The rest of the properties will stay the same.
In case of selectedVariants, when the collection is updated, the old one is completely removed.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
cartId required | string Example: "V" The cart ID |
contactId | string The ID of the contact that the cart belongs to. You must first create the contact using POST /v3/contacts, or if it already exists, using GET /v3/contacts |
totalPrice | number <double> [ 0 .. 999999999999.99 ] The total cart price, tax excluded |
totalTaxPrice | number <double> [ 0 .. 999999999999.99 ] The total cart price, tax included |
currency | string 3 characters The currency code (ISO 4217) |
selectedVariants | Array of object (NewCartSelectedProductVariant) |
externalId | string The external ID is the identifying string or number of the cart, given by another software |
cartUrl | string <url> The external cart URL |
The cart details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
cartId required | string Example: "V" The cart ID |
Delete cart
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Sending a GET request to this URL returns a collection of category resources that belong to the given shop.
You can narrow down the list of resources by passing proper query parameters (the list of which you can find below in the request params section). You can basically search by: *name
The name
fields can be a pattern and we'll try to match this phrase.
The parentId
will search for sub-categories of a given parent category.
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
query[name] | string Search category by name |
query[parentId] | string Search categories by their parent |
query[externalId] | string Search categories by external ID |
search[createdAt][from] | string <date-time> Show categories starting from this date |
search[createdAt][to] | string <date-time> Show categories starting to this date |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by name |
sort[createdAt] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of categories
Request validation error
Authentication error
The throttling limit has been reached
Create shop category. You can pass the parentId
parameter to create a sub-category of a given parent. Unlike most POST methods, this call is idempotent, that is: sending the same request 10 times will not create 10 new categories. Only one category will be created.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
name required | string [ 2 .. 64 ] characters The name of the category |
parentId | string [ 2 .. 64 ] characters The parent category ID |
isDefault | boolean This is a default category |
url | string <uri> <= 2048 characters The external URL to the category |
externalId | string <= 255 characters The external ID is the identifying string or number of the category given by another software |
The category details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
This method returns a category according to the given categoryId
.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
categoryId required | string Example: "C3s" The category ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The category details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Update the properties of the shop category. You can specify a parentId
to assign a category as sub-category for an existing category. You should send only those fields that need to be changed. The rest of the properties will stay the same.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
categoryId required | string Example: "C3s" The category ID |
name | string [ 2 .. 64 ] characters The name of the category |
parentId | string [ 2 .. 64 ] characters The parent category ID |
isDefault | boolean This is a default category |
url | string <uri> <= 2048 characters The external URL to the category |
externalId | string <= 255 characters The external ID is the identifying string or number of the category given by another software |
The category details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
categoryId required | string Example: "C3s" The category ID |
Delete category
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Sending a GET request to this URL returns a collection of meta field resources that belong to the given shop.
You can narrow down the list of resources by passing proper query parameters (the list of which you can find below in the request params section). You can basically search by:
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
query[name] | string Search meta fields by name |
query[description] | string Search meta fields by description |
query[value] | string Search meta fields by value |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search meta fields created from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search meta fields created to this date |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of meta fields
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Sending a POST request to this URL will create a new meta field resource.
In order to create a new meta field, you need to send a meta field resource in the body of the request (remember that you need to serialize the body into a JSON string)
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
name required | string [ 3 .. 63 ] characters The meta field name |
value required | string [ 0 .. 65000 ] characters The meta field value |
valueType required | string Enum:"string" "integer" The value type enumerable |
description | string [ 0 .. 255 ] characters The meta field description |
The meta field details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
This method returns meta field with a given metaFieldId
in the context of a given shopId
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
metaFieldId required | string Example: "hgF" The metafield ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The meta field details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Update the properties of a shop's meta field. You should send only those fields that need to be changed. The rest of the properties will stay the same.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
metaFieldId required | string Example: "hgF" The metafield ID |
name | string [ 3 .. 63 ] characters The meta field name |
value | string [ 0 .. 65000 ] characters The meta field value |
valueType | string Enum:"string" "integer" The value type enumerable |
description | string [ 0 .. 255 ] characters The meta field description |
The meta field details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
metaFieldId required | string Example: "hgF" The metafield ID |
Delete meta field
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Sending a GET request to this URL returns a collection of order resources that belong to the given shop.
You can narrow down the list of resources by passing proper query parameters (the list of which you can find below in the request params section). You can basically search by:
The description
fields can be a pattern and we'll try to match this phrase.
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
query[description] | string Search order by description |
query[status] | string Search order by status |
query[externalId] | string Search order by external ID |
query[processedAt][from] | string <date-time> Show orders processed from this date |
query[processedAt][to] | string <date-time> Show orders processed to this date |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of orders
Request validation error
Authentication error
The throttling limit has been reached
Sending a POST request to this URL will create a new order resource.
In order to create a new order, you need to send the order resource in the body of the request (remember that you need to serialize the body into a JSON string).
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
additionalFlags | string Example: "skipAutomation" The additional flags parameter with the value |
selectedVariants required | Array of object (NewSelectedProductVariant) |
contactId required | string Create a contact by using |
orderUrl | string <uri> <= 2048 characters The external URL for an order |
externalId | string <= 255 characters The external ID is the identifying string or number of the order given by another software |
totalPrice required | number <double> [ 0 .. 999999999999.99 ] The total price of an order |
totalPriceTax | number <double> [ 0 .. 999999999999.99 ] The total price tax of an order |
currency required | string The order currency code (ISO 4217) |
status | string <= 64 characters The status value |
cartId | string Create a cart by using |
description | string The order description |
shippingPrice | number <double> [ 0 .. 999999999999.99 ] The shipping price for an order |
shippingAddress | object (NewAddress) The shipping address for an order |
billingStatus | string The billing status of an order |
billingAddress | object (NewAddress) The billing address for an order |
processedAt | string <date-time> The exact time an order was made |
metaFields | Array of object (NewMetaField) |
The order details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
This method returns the order according to the given orderId
.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
orderId required | string Example: "fOh" The order ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The order details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Update the properties of a shop's order. You should send only those fields that need to be changed. The rest of the properties will stay the same.
However, in case of billingAddress
and shippingAddress
, you must send the entire representation. Individual fields can't be updated.
If you want to update individual fields of an address, you can do so using POST /v3/addresses/{addressId}
.
In case of selectedVariants
, when the collection is updated, the old collection is completely removed. The same goes for meta fields.
Individual fields can't be updated either. The full representations of selectedVariants
and metaFields
must be sent instead.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
orderId required | string Example: "fOh" The order ID |
additionalFlags | string Example: "skipAutomation" The additional flags parameter with the value |
contactId | string Create a contact by using |
orderUrl | string <uri> <= 2048 characters The external URL for an order |
externalId | string <= 255 characters The external ID is the identifying string or number of the order given by another software |
totalPrice | number <double> [ 0 .. 999999999999.99 ] The total price of an order |
totalPriceTax | number <double> [ 0 .. 999999999999.99 ] The total price tax of an order |
currency | string The order currency code (ISO 4217) |
status | string <= 64 characters The status value |
cartId | string Create a cart by using |
description | string The order description |
shippingPrice | number <double> [ 0 .. 999999999999.99 ] The shipping price for an order |
shippingAddress | object (NewAddress) The shipping address for an order |
billingStatus | string The billing status of an order |
billingAddress | object (NewAddress) The billing address for an order |
processedAt | string <date-time> The exact time an order was made |
metaFields | Array of object (NewMetaField) |
The order details
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
orderId required | string Example: "fOh" The order ID |
Delete order
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Sending a GET request to this URL returns a collection of product resources that belong to the given shop.
You can narrow down the list of resources by passing proper query parameters (the list of which you can find below in the request params section). You can basically search by:
The metaFieldNames
and metaFieldValues
fields can be a list of values separated by a comma [,].
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
query[name] | string Search products by name |
query[vendor] | string Search products by vendor |
query[category] | string Search products by category name |
query[categoryId] | string Search products by category ID |
query[externalId] | string Search products by external ID |
query[variantName] | string Search products by product variant name |
query[metaFieldNames] | string Search products by meta field name (the list of names must be separated by a comma [,]) |
query[metaFieldValues] | string Search products by meta field value (the list of values must be separated by a comma [,]) |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search products created from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search products created to this date |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by name |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of products
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Sending a POST request to this URL will create a new product resource.
In order to create a new product, you need to send the product resource in the body of the request (remember that you need to serialize the body into a JSON string)
You don't need a separate endpoint for each element (e.g. variant, category, meta-field). You can create them all with this method.
Please note that categories aren't required, but if a product has at least one category, then one of those categories must be marked as default.
This can be set by field isDefault
. If none of the elements contains isDefault=true, then the system picks the first one from the collection by default.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
name required | string [ 2 .. 255 ] characters The product name |
type | string [ 2 .. 64 ] characters The product type |
url | string <uri> <= 2048 characters The external URL for the product |
vendor | string [ 2 .. 64 ] characters The product vendor |
externalId | string <= 255 characters The external ID is the identifying string or number of the product given by another software |
categories | Array of object (NewProductCategory) |
variants required | Array of object (NewProductVariant) |
metaFields | Array of object (NewMetaField) |
The product details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
This method returns product according to the given productId
in the context of a given shopId
.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
productId required | string Example: "9I" The product ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The product details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Update the properties of a shop's product. You should only send those fields that need to be changed. The remaining properties will stay the same. However, when updating variants, categories, and meta fields, you need to send entire collections. Individual fields can't be updated. If you want to update particular fields, you can do so using their specific endpoints, i.e.:
POST /v3/shops/{shopId}/categories/{categoryId}
/v3/shops/{shopId}/products/{productId}/variants/{variantId}
POST /v3/shops/{shopId}/meta-fields/{metaFieldId}
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
productId required | string Example: "9I" The product ID |
name | string [ 2 .. 255 ] characters The product name |
type | string [ 2 .. 64 ] characters The product type |
url | string <uri> <= 2048 characters The external URL for the product |
vendor | string [ 2 .. 64 ] characters The product vendor |
externalId | string <= 255 characters The external ID is the identifying string or number of the product given by another software |
categories | Array of object (NewProductCategory) |
variants | Array of object (NewProductVariant) |
metaFields | Array of object (NewMetaField) |
The product details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
productId required | string Example: "9I" The product ID |
Delete product
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
This method makes it possible to assign product categories, and to set a default product category. This method doesn't remove or unassign product categories. It returns a list of product categories.
Please note that if you assign only one category to a given product, that category is marked as default. If you try to remove the default mark, your change won't be executed.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
productId required | string Example: "9I" The product ID |
categories required | Array of object (UpsertSingleProductCategory) |
The list of product categories
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
This method makes it possible to assign meta fields. It doesn't remove or unassign meta fields. It returns a list of product meta fields.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
productId required | string Example: "9I" The product ID |
metaFields required | Array of object (UpsertSingleMetaField) |
The list of meta fields
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Sending a GET request to this URL returns a collection of product variant resources that belong to the given shop and product.
You can narrow down the list of resources by passing proper query parameters (the list of which you can find below in the request params section). You can basically search by:
The description
fields can be a pattern and we'll try to match this phrase.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
productId required | string Example: "9I" The product ID |
query[name] | string Search variant by name |
query[sku] | string Search variant by SKU |
query[description] | string Search variant by description |
query[externalId] | string Search variant by external ID |
query[createdAt][from] | string <date-time> Show variants starting from this date |
query[createdAt][to] | string <date-time> Show variants starting to this date |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of product variants
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Sending a POST request to this URL will create a new product variant resource.
In order to create a new product variant, you need to send a product variant resource in the body of the request (remember that you need to serialize the body into a JSON string)
There is no need to create every element (like: image, meta field, tax) one by one by their own endpoints. All these elements can be created during this method.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
productId required | string Example: "9I" The product ID |
name required | string [ 1 .. 255 ] characters The product name |
url | string <uri> <= 2048 characters The external URL to the product variant |
sku required | string [ 2 .. 255 ] characters The stock-keeping unit of a variant. Must be unique within the product |
price required | number <double> The price |
priceTax required | number <double> The price including tax |
previousPrice | number <double> Nullable The price before the change |
previousPriceTax | number <double> Nullable The price before the change including tax |
quantity | integer <int64> Default: 1 The quantity of variant items |
position | integer <int64> The position of a variant |
barcode | string [ 2 .. 255 ] characters The barcode of a variant |
externalId | string <= 255 characters The external ID is the identifying string or number of the variant given by another software |
description | string [ 2 .. 1000 ] characters The description of a variant |
images | Array of object (NewProductVariantImage) |
metaFields | Array of object (NewMetaField) |
taxes | Array of object (NewTax) |
The product variant details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
This method returns product variant according to the given variantId
in the context of a given shopId
and productId
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
productId required | string Example: "9I" The product ID |
variantId required | string Example: "VTB" The variant ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The product variant details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Update properties of a product variant. You should send only those fields that need to be changed. The remaining properties will stay the same. However, when updating metafields, images, and taxes, you need to send entire collections. Individual fields can't be updated. If you want to update particular metafields or tax resources, you can do so using their particular endpoints, i.e:
POST /v3/shops/{shopId}/taxes/{taxId}
POST /v3/shops/{shopId}/meta-fields/{metaFieldId}
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
productId required | string Example: "9I" The product ID |
variantId required | string Example: "VTB" The variant ID |
name | string [ 1 .. 255 ] characters The product name |
url | string <uri> <= 2048 characters The external URL to the product variant |
sku | string [ 2 .. 255 ] characters The stock-keeping unit of a variant. Must be unique within the product |
price | number <double> The price |
priceTax | number <double> The price including tax |
previousPrice | number <double> Nullable The price before the change |
previousPriceTax | number <double> Nullable The price before the change including tax |
quantity | integer <int64> Default: 1 The quantity of variant items |
position | integer <int64> The position of a variant |
barcode | string [ 2 .. 255 ] characters The barcode of a variant |
externalId | string <= 255 characters The external ID is the identifying string or number of the variant given by another software |
description | string [ 2 .. 1000 ] characters The description of a variant |
images | Array of object (NewProductVariantImage) |
metaFields | Array of object (NewMetaField) |
taxes | Array of object (NewTax) |
The product variant details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
productId required | string Example: "9I" The product ID |
variantId required | string Example: "VTB" The variant ID |
Delete product variant
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
This method returns the shop according to the given shopId
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The shop details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
This makes it possible to update shop preferences. You should send only those fields that need to be changed. The rest of the properties remain the same.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
name | string [ 4 .. 124 ] characters The shop name |
locale | string The language locale (ISO 639-1) |
currency | string The currency code (ISO 4217) |
The shop details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
This method deletes a shop.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
Delete a shop
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Sending a GET request to this URL returns a collection of shop resources.
You can narrow down the list of resources by passing proper query parameters (the list of which you can find below in the request params section). You can basically search by:
The name
fields can be a pattern and we'll try to match this phrase.
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search shop by name |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by name |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of shops
Request validation error
Authentication error
The throttling limit has been reached
This method makes it possible to create a new shop.
Authorizations: | api-keyoauth2 (all ) |
name required | string [ 4 .. 124 ] characters The shop name |
locale required | string The language locale (ISO 639-1) |
currency required | string The currency code (ISO 4217) |
The shop details
Request validation error
Authentication error
The throttling limit has been reached
Sending GET request to this URL returns a collection of tax resources that belong to the given shop.
You can narrow down the list of resources by passing proper query parameters (the list of which you can find below, in the request params section). You can basically search by:
query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
query[name] | string Search tax by name |
query[createdOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search tax created from this date |
query[createdOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search tax created to this date |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of taxes
Request validation error
Authentication error
The throttling limit has been reached
Sending a POST request to this URL will create a new tax resource.
In order to create a new tax, you need to send a tax resource in the body of the request (remember that you need to serialize the body into a JSON string)
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
name required | string [ 2 .. 255 ] characters The tax name |
rate required | number <double> [ 0 .. 99.9 ] The rate value |
The tax details
Request validation error
Authentication error
The throttling limit has been reached
This method returns tax with a given taxId
in the context of a given shopId
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
taxId required | string Example: "Sk" The tax ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The tax details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Update the properties of the shop tax. You should only send the fields that need to be changed. The rest of the properties will stay the same.
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
taxId required | string Example: "Sk" The tax ID |
name | string [ 2 .. 255 ] characters The tax name |
rate | number <double> [ 0 .. 99.9 ] The rate value |
The tax details
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
shopId required | string Example: "pf3" The shop ID |
taxId required | string Example: "Sk" The tax ID |
Delete tax
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
transactionalEmailId required | string Example: "tRe4i" |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
Transactional email details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[sentOn][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search transactional emails sent from this date |
query[sentOn][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Search transactional emails sent to this date |
query[tagged] | string (StringBooleanEnum) Enum:"true" "false" Search tagged/untagged transactional emails |
query[tagId] | string Search transactional emails with a specific tag ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of transactional emails
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
fromField required | object (FromFieldReference) The 'From' address ID to be used as the message sender |
replyTo | object (FromFieldReference) The 'From' address ID to be used as the Reply-to |
tag | object (NewTransactionalEmailTag) The tag ID used for statistical data collection |
recipients required | object (TransactionalEmailRecipients) |
contentType required | string Default: "direct" The message content type direct |
subject required | string [ 1 .. 512 ] characters |
attachments | Array of object (TransactionalEmailAttachment) |
content required | object The message content. At least one field is required. The maximum combined size of plain text and HTML is 16MB |
Transactional email.
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
query[groupBy] required | string Enum:"total" "day" Group results by time interval |
query[timeFrame][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data from this date |
query[timeFrame][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Count data to this date |
query[tagged] | string (StringBooleanEnum) Enum:"true" "false" Search tagged/untagged transactional emails |
query[tagId] | string Search transactional emails with a specific tag ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The overall statistics of transactional emails
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
transactionalEmailTemplateId required | string Example: "abc" Transactional emails template identifier |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
Transactional emails template details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
This method allows you to update transactional email template
Authorizations: | api-keyoauth2 (all ) |
transactionalEmailTemplateId required | string Example: "abc" Transactional emails template identifier |
subject | string The template subject |
content | object (TransactionalEmailTemplateContent) The template content. At least one field is required |
Transactional emails template details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
transactionalEmailTemplateId required | string Example: "abc" Transactional emails template identifier |
Delete transactional email template
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[subject] | string Search templates by subject |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by creation date |
sort[subject] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by template subject |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
Transactional email templates listing
Request validation error
Authentication error
The throttling limit has been reached
This method creates a new transactional email template
Authorizations: | api-keyoauth2 (all ) |
subject required | string The template subject |
content | object (TransactionalEmailTemplateContent) The template content. At least one field is required |
Transactional emails template details
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
smsId required | string Example: "N" The SMS message ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The SMS message details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[type] | string Enum:"sms" "draft" Search SMS messages by type |
query[name] | string Search SMS messages by name |
query[sendingStatus] | string Enum:"scheduled" "sending" "sent" Search SMS messages by status |
query[campaignId] | string Search SMS messages by campaign (list) ID |
query[hasLinks] | boolean Search for SMS messages with links |
sort[sendingStatus] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by sending status |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by name |
sort[sendOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by sending date |
sort[modifiedOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by modification date |
sort[delivered] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by number of delivered messages |
sort[sent] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by number of sent messages |
sort[clicks] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by number of link clicks |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The SMS message listing
Request validation error
Authentication error
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search automated SMS messages by name |
query[campaignId] | string Search automated SMS messages by campaign (list) ID |
query[hasLinks] | boolean Search for automated SMS messages containing links |
sort[status] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by the status of the SMS message |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by the name of the automated SMS message |
sort[modifiedOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by the date the SMS message was modified on |
sort[delivered] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by the number of delivered SMS messages |
sort[sent] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by the number of sent SMS messages |
sort[clicks] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by the number of link clicks |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of the automated SMS messages
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
query[orderDate][from] | string <date> Show statistics for orders from this date |
query[orderDate][to] | string <date> Show statistics for orders to this date |
query[shopId] | string Search statistics by shop ID. You can get the shop ID by calling the |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
Revenue statistics
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
query[orderDate][from] | string <date> Show statistics for orders from this date |
query[orderDate][to] | string <date> Show statistics for orders to this date |
query[shopId] | string Search statistics by shop ID. You can get the shop ID by calling the |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
General performance statistics
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
smsId required | string Example: "N" The SMS message ID |
query[createdOn][from] | string <date> Example: "2023-01-20" Get statistics for a single SMS from this date |
query[createdOn][to] | string <date> Example: "2023-01-20" Get statistics for a single SMS to this date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
SMS statistics
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
websiteId required | string Example: "ce84fabc-1349-4992-a2d7-0c44c5534128" The website ID |
query[date][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Show a single website statistics from this date |
query[date][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Show a single website statistics to this date |
query[location] | string Website statistics by location |
query[device] | string Enum:"desktop" "mobile" Website statistics by device |
query[page] | string Website statistics by a page UUID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
Website statistics
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
lpsId required | string Example: "ce84fabc-1349-4992-a2d7-0c44c5534128" The landing page ID |
query[date][from] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Show a single landing page statistics from this date |
query[date][to] | string <date> or string <date-time> (DateOrDateTime) Example: "2018-04-15" "2018-01-15T13:30:42+0000" Show a single landing page statistics to this date |
query[location] | string Landing page statistics by location |
query[device] | string Enum:"desktop" "mobile" Landing page statistics by device |
query[page] | string Landing page statistics by page UUID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
Landing page statistics
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
popupId required | string Example: "ce84fabc-1349-4992-a2d7-0c44c5534128" The form or popup ID |
query[date][from] | string <date> Example: "2023-01-10" Get statistics for a single form or popup from this date |
query[date][to] | string <date> Example: "2023-01-20" Get statistics for a single form or popup to this date |
query[location] | string Form or popup statistics by location |
query[device] | string Enum:"desktop" "mobile" Form or popup statistics by device |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
Form or popup statistics
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
webinarId required | string Example: "yK6d" The webinar ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The webinar details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search webinars by name |
query[campaignId] | string The list of campaign resource IDs (string separated with ',') |
query[status] | string Enum:"upcoming" "finished" "published" "unpublished" Search webinars by status |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort webinars by name |
sort[createdOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort webinars by creation date |
sort[startsOn] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort webinars by update date |
query[type] | string Enum:"all" "live" "on_demand" Search webinars by type |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of webinars
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
websiteId required | string Example: "ce84fabc-1349-4992-a2d7-0c44c5534128" The website ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The website details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search websites by name |
query[status] | string Enum:"published" "unpublished" Search websites by status |
stats[from] | string <date-time> Show statistics for websites from this date |
stats[to] | string <date-time> Show statistics for websites to this date |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort websites by name |
sort[createdAt] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort websites by creation date |
sort[updatedAt] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort websites by modification date |
sort[pageViews] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort websites by page views |
sort[visits] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by number of site visits |
sort[uniqueVisitors] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by number of unique visitors |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of tags
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
lpsId required | string Example: "ce84fabc-1349-4992-a2d7-0c44c5534128" The landing page ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The landing page details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search landing pages by name |
query[status] | string Enum:"published" "unpublished" Search landing pages by status |
stats[from] | string <date-time> Show statistics for landing pages from this date |
stats[to] | string <date-time> Show statistics for landing pages to this date |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort landing pages by name |
sort[createdAt] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort landing pages by creation date |
sort[updatedAt] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort landing pages by modification date |
sort[visits] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by number of page visits |
sort[leads] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort landing pages by number of leads |
sort[subscriptionRate] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by subscription rate |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of tags
Request validation error
Authentication error
The throttling limit has been reached
Authorizations: | api-keyoauth2 (all ) |
popupId required | string Example: "ce84fabc-1349-4992-a2d7-0c44c5534128" The form or popup ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
Form or popup details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search forms and popups by name |
query[status] | string Enum:"published" "unpublished" Search forms and popups by status |
stats[from] | string <date-time> Show statistics from this date |
stats[to] | string <date-time> Show statistics to this date |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort forms and popups by name |
sort[status] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort forms and popups by status |
sort[createdAt] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort forms and popups by creation date |
sort[updatedAt] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort forms and popups by modification date |
sort[views] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by number of views |
sort[uniqueVisitors] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by number of unique visitors |
sort[leads] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by number of leads |
sort[ctr] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort by CTR (click-through rate) |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of forms and popups
Request validation error
Authentication error
The throttling limit has been reached
The endpoint allows retrieving detailed information about a custom report based on the provided customReportId
. It returns report data, including:
More information on using custom reports can be found in the Case Study section of the API documentation.
Authorizations: | api-keyoauth2 (all ) |
customReportId required | string The custom report ID |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
The custom report details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached
You can filter the resource using criteria specified as query[*]
. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as sort[*]
. You can specify multiple fields to sort by.
Authorizations: | api-keyoauth2 (all ) |
query[name] | string Search custom reports by name |
sort[name] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort custom reports by name |
sort[frequency] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort custom reports by frequency |
sort[generatedAt] | string (SortOrderEnum) Enum:"ASC" "DESC" Sort custom reports by generation date |
fields | string List of fields that should be returned. Id is always returned. Fields should be separated by comma |
perPage | integer <int32> [ 1 .. 1000 ] Default: 100 Requested number of results per page |
page | integer <int32> >= 1 Default: 1 Page number |
The list of custom reports
Request validation error
Authentication error
The throttling limit has been reached
The endpoint allows scheduling a custom report of a specific type for a given time period. Depending on the report type, you can also narrow down the data using appropriate filters.
More information about using the endpoint, along with examples, can be found in the Case Study section of the API documentation.
Authorizations: | api-keyoauth2 (all ) |
name required | string [ 3 .. 70 ] characters The custom report name |
type required | string The custom report type bounces |
scheduling required | object Parameters responsible for defining the reporting period |
The custom report details
Request validation error
Authentication error
Resource not found
The throttling limit has been reached