ClickSend is a cloud business communication provider which helps you get and stay closer to your customers and staff using SMS, Email and Direct Mail via web app or API.

Data integration: Skyvia supports importing data to and from ClickSend, exporting ClickSend data to CSV files, replicating ClickSend data to relational databases, and synchronizing ClickSend data with other cloud apps and relational databases.

Backup: Skyvia Backup does not support ClickSend backup.

Query: Skyvia Query supports ClickSend.

Establishing Connection

To create a connection with ClickSend, you must specify the Username value and an API Key.

Getting Credentials

To obtain the credentials, perform the following steps:

  1. Sign-in to ClickSend and click on the key image near your user icon in the top right corner of your ClickSend page.
  2. Copy the credentials from the appeared dialog box.

    get API key

Creating Connection

To create a connection between Skyvia and ClickSend, do the following:

  1. Enter a username.
  2. Enter your API Key.
  3. Click Create Connection.

    ClickSend connection

Connector Specifics

Object Peculiarities

When importing data to the Contacts table, you must map the required ListId field and one of the following fields: PhoneNumber, FaxNumber or Email.

Incremental Replication and Synchronization

Replication with Incremental Updates is supported for the following objects: Contacts, DeliveryIssues, EmailAddresses, EmailCampaigns, FaxHistory, LettersHistory, MasterEmailTemplates, MMSCampaigns, PostcardsHistory, SMSCampaigns, TransactionalEmailHistory, VoiceHistory.

The Contacts object has both CreatedDate and UpdatedDate fields, thus, Incremental Replication detects both new records and updated records.

For all other objects, the Incremental Replication detects only the new records because all these objects have the CreatedDate field and do not have the UpdatedDate field required for tracking the updates.

Synchronization is supported for the Contacts object only.

DML Operations

Skyvia supports the following DML operations for ClickSend objects:

Operation Object
INSERT, UPDATE, DELETE ContactLists, Contacts, EmailDeliveryReceiptRules, FaxDeliveryReceiptRules, InboundFaxRules, InboundSMSRules, ReturnAddresses, SMSDeliveryReceiptRules, SMSTemplates, StrippedStringRules, Subaccounts, UserEmailTemplates, VoiceDeliveryReceiptRules
INSERT, UPDATE EmailCampaigns, MMSCampaigns, ResellerAccounts, SMSCampaigns
INSERT, DELETE EmailAddresses
INSERT Accounts, DeliveryIssues, EmailToSMS, InboundSMS, SMSReceipts

Stored Procedures

Part of the ClickSend functionality is implemented in Skyvia as stored procedures. Here is the list of them:

  • call SendAccountVerification(:country, :user_phone, :type) — sends the account for the verification.
  • call VerifyAccount(:activation_token) — verifies account with the activation token.
  • call ForgotUsername(:email) — if the user forgot the username, this procedure sends the Email with the necessary information.
  • call ForgotPassword(:username) — if the user forgot the password, this procedure sends the Email with a code. This code should be sent as the :activation_token parameter for the VerifyForgotPassword procedure.
  • call VerifyForgotPassword(:subaccount_id, :activation_token, :password) — allows setting a new password. Pass the code received as a result of the call ForgotPassword(:username) procedure. Specify a new password as a :password parameter value.
  • call PurchaseRechargePackage(:package_id) — is used to purchase a recharge package with the specified Id.
  • call CopyContactToList(:from_list_id, :contact_id, :to_list_id) — copies the contact from one list to another. The contact obtains a new Id after copying.
  • call TransferContactToList(:from_list_id, :contact_id, :to_list_id) — moves the contact from one list to another. The Id of the moved contact remains the same after executing the procedure.
  • call RemoveOptedOutContacts(:list_id, :opt_out_list_id) — moves all the opted-out contacts from the specified list to the opt-out list.
  • call SendEmailVerificationToken(:email_address_id) — verification mail is being sent to the specified email. After that, this email address is valid; you can use it for campaign sending.
  • call VerifyAllowedEmailAddress(:email_address_id, :activation_token) — confirming email using activation token.
  • call CancelEmailCampaign(:email_campaign_id) — cancels Email campaign sending.
  • call CancelMMSCampaign(:mms_campaign_id) — cancels MMS campaign sending.
  • call PurchaseDedicatedNumber(:dedicated_number) — buys the dedicated number.
  • call CancelScheduledLetter(:message_id) — cancels the scheduled letter.
  • call CancelScheduledPostcard(:message_id) — cancels the postcard sending.
  • call ResellerTransferCredit(:client_user_id, :balance, :currency) — to transfer the amount specified as a balance parameter to another account.
  • call SendSMS(:from, :body, :to) — sends SMS. Parameters :from, :to and :body (sms content) are required.
  • call MarkSMSReceiptAsRead(:date_before) — marks all the receipts dated before the specified date as read.
  • call MarkInboundSMSAsRead(:date_before) — marks all the sms dated before the data specified in the date_before parameter as read.
  • call MarkSpecificInboundSMSAsRead(:message_id) — marks all the sms with the specified id as read.
  • call CancelSMS(:message_id) — cancel the sms with specified id sending.
  • call CancelSMSCampaign(:sms_campaign_id) — cancels sending of the sms campaign with specified id.
  • call GenerateNewAPIKey(:subaccount_id) — generates new API Key for the specified subaccount. New API Key returns as a response.
  • call SendVoiceMessage(:body, :to, :voice, :custom_string, :country) — sends voice message. Specify the required parameters :body, :to, :voice, :custom_string, :country.
  • call CancelVoiceMessage(:message_id) — cancels sending the voice mail with the specified id.

You can use a call to the stored procedure, for example, as a text of the command in the Execute Command action in a Target component of a Data Flow, Advanced Task Editor mode in Import and Export, or in Query.

Supported Actions

Skyvia supports all the common actions for ClickSend.