GetResponse API v1.5.0 Documentation
This is last JSON-RPC version of GetResponse API. The next major version of our API will be completely redesigned, with a lot of new features and total overhaul. Below we’ve put our API catalogue, where you can find all API calls categorized in sections for easy navigation. Just click on a category name and browse to find the method you desire.
Automation workflow support
Please be aware that this version of api DOES NOT support workflow automation eg. updating contacts's custom field or any other change will NOT trigger automation workflows. If You need automation workflow support please switch to our current stable api version: API v3
Method Sections
- Accounts/get_account_info
Get basic info about your account
- Accounts/get_account_from_fields
Get a list of email addresses assigned to account.
- Accounts/add_account_from_field
Assign email address to an account. It can be used in newly created campaigns. When you add a from field, from a web interface a clicking confirmation link is required. But when you use API then it is confirmed by default and ready to use.
- Accounts/get_account_domains
Get domains assigned to account
- Accounts/get_account_customs
Get all defined custom fields for contacts in the account
- Accounts/add_account_custom
Add a custom field definition to account.
- Accounts/set_account_custom_contents
Modify custom field values available for selection (for radio, checkbox and select option)
- Accounts/delete_account_custom
Remove custom field from account and all contacts. This action is not reversible!
- Blacklists/get_account_blacklist
Get blacklist masks on account level
- Blacklists/add_account_blacklist
Get contact segments saved on web interface to use in send_newsletter
- Blacklists/delete_account_blacklist
Delete blacklist mask on account level
- Blacklists/get_campaign_blacklist
Get blacklist masks on campaign level
- Blacklists/add_campaign_blacklist
Adds blacklist mask on campaign level
- Blacklists/delete_campaign_blacklist
Delete blacklist mask on campaign level
- Callbacks/get_account_callbacks
Get callbacks configuration for account
- Callbacks/set_account_callbacks
Set callbacks configuration for account
- Callbacks/delete_account_callbacks
Delete callbacks configuration for account
- Campaigns/delete_campaign_domain
Detach account domain from campaign. Detached domain will no longer be used in links in messages sent from this campaign.
- Campaigns/get_campaign_postal_address
Get postal address and postal design (formatting) in campaign. Postal address is attached to every message sent from campaign
- Campaigns/set_campaign_postal_address
Set a postal address and postal design (formatting) in campaign. Postal address is attached to every message sent from a campaign
- Campaigns/get_campaign_predefines
Get predefined fields in campaign
- Campaigns/add_campaign_predefine
Add a predefined field to campaign
- Campaigns/get_campaigns
Get a list of campaigns in account
- Campaigns/delete_campaign_predefine
Delete a predefined field in campaign
- Campaigns/get_campaign
Get a single campaign using CAMPAIGN_ID. Useful for checking which campaign the contact or message belongs to
- Campaigns/add_campaign
Add a campaign to account
- Campaigns/get_campaign_domain
Check if any account domain is assigned to campaign. Assigned domain will be used in links in messages sent from this campaign
- Campaigns/set_campaign_domain
Assign an account domain to campaign. Assigned domain will be used in links in messages sent from this campaign
- Confirmation/get_confirmation_subject
Get a single subject for confirmation message using CONFIRMATION_SUBJECT_ID
- Confirmation/get_confirmation_bodies
Get list of available bodies for confirmation messages. They can be used in campaign settings
- Confirmation/get_confirmation_body
Get a single body for confirmation message using CONFIRMATION_BODY_ID
- Confirmation/get_confirmation_subjects
Get a list of available subjects for confirmation messages. They can be used in campaign settings
- Contacts/get_contacts_subscription_stats
Get contacts subscription stats aggregated by time period, campaign and contact’s origin
- Contacts/get_contacts
Get list of contacts from the account
- Contacts/get_contacts_ununsubscription_stats
Get contacts unsubscribing stats aggregated by time period, campaign, and reason
- Contacts/get_contact
Get a single contact using CONTACT_ID
- Contacts/get_contacts_amount_per_account
Get the total amount of contacts in your account.
- Contacts/set_contact_name
Set contact name
- Contacts/get_contacts_amount_per_campaign
Get total contacts amount in every campaign on your account
- Contacts/get_contact_customs
Get list of contact customs
- Contacts/get_contacts_distinct_amount
Get amount of unique email addresses of your contacts
- Contacts/set_contact_customs
Set contact customs
- Contacts/get_segments
Get contact segments saved on web interface to use in send_newsletter
- Contacts/get_contact_geoip
Get a contact’s geo location based on the IP address from which the subscription was processed
- Contacts/get_contact_opens
List dates when messages were opened by contact
- Contacts/get_contact_clicks
List dates on which the links in messages were clicked by contact
- Contacts/get_contact_goals
List dates when goals were reached by contacts
- Contacts/get_contact_surveys
List survey results filled by contacts.
- Contacts/set_contact_cycle
Place a contact on a desired day of the autoresponder cycle or deactivate a contact
- Contacts/add_contact
Add contact to the list
- Contacts/move_contact
Move contact from one campaign to another
- Contacts/delete_contact
Delete contact
- Contacts/get_contacts_deleted
Get deleted contacts
- Contacts/get_contact_sends
List dates when messages were sent to contact
- Goals/get_goals
Get goals
- Goals/get_goal
Get single goal using GOAL_ID
- Imports/get_import
Get single import using IMPORT_ID
- Imports/get_import_stats
Get statistics of import using IMPORT_ID
- Imports/get_imports
Get imports
- Links/get_links
Get click tracked links
- Links/get_link
Get single click tracked link using LINK_ID
- Messages/get_newsletter_statuses
Get statuses of newsletter messages
- Messages/get_messages
Get messages in account
- Messages/get_message
Get selected message
- Messages/get_message_contents
Get message contents (parts)
- Messages/get_message_stats
Get message statistics
- Messages/send_newsletter
Queue a newsletter to be sent
- Messages/add_autoresponder
Add a time based autoresponder to the campaign at the specific day of cycle
- Messages/add_draft
Add a draft of given message type to the campaign. Useful for autosave features
- Messages/delete_newsletter
Delete newsletter from campaign
- Messages/delete_autoresponder
Delete a time based autoresponder from campaign
- Messages/delete_draft
Delete draft from campaign
- Messages/set_autoresponder_cycle
Set day of cycle in an existing time based autoresponder
- Messages/get_messages_amount_per_account
Get the total amount of messages in your account
- Messages/get_messages_amount_per_campaign
Get the total amount of messages in every campaign in your account
- Servers/add_account
Add new account to server
- Servers/get_accounts
List all accounts on server
- Servers/get_account
Get one account on server using ACCOUNT_ID
- Servers/set_account_status
Enable or disable account or its features
- Suppressions/get_suppressions
Get list of defined suppression lists on your account
- Suppressions/get_suppression
Get single suppression using SUPPRESSION_ID
- Suppressions/add_suppression
Add suppression list to your account
- Suppressions/delete_suppression
Delete suppression list from your account
- Suppressions/get_suppression_skiplist
Get suppression skiplist based on SUPPRESSION_ID
- Suppressions/add_suppression_skiplist
Add mask to a set of masks for suppression
- Suppressions/delete_suppression_skiplist
Delete mask from a set of masks for suppression
- Surveys/get_surveys
Get surveys
- Surveys/get_survey
Get single survey using SURVEY_ID
- Surveys/get_survey_stats
Get message statistics with summary of every choice
- WebForms/get_webforms
Get webforms
- WebForms/get_webform
Get single webform using WEBFORM_ID
- testing/ping
Testing method
License
Copyright 2014 GetResponse Sp. z o.o.
Licensed under the Artistic License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://opensource.org/licenses/Artistic-2.0Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License