Get action details

https://areamembri.it/campaigns/get_action_details.json

Retrieves the detailed information for an action inside a campaign.

Parameters:

api_user The provided API User credential for your account.
api_key The provided API Key credential for your account.
business_id

(optional)

 The project ID you want to query in. If not specified, the account will be used.
campaign_id The campaign ID in which the action is included.
action_id The action ID for which you want the details.

Return:

An action object containing, at least:

  • id: the action unique identifier.
  • active: if the action is active or not.
  • type: the kind of action. An action can be of one among multiple types, some of them are:
    • EmailAction: followup, this action sends an email to the subscribed user.
    • CustomEmailAction: custom notification, this action sends an email to a custom recipient list.
    • AddToCampaignAction: copy to another campaign. This action subscribes the user to another specified campaign.
    • RemoveFromCampaignAction: removes the user from another campaign, if subscribed.
    • HttpPostAction: sends a custom HTTP post call to an URL, with a defined list of query parameters.
    • GrantPageVisibilityAction: grants the user access to a specific protected page.
    • DenyPageVisibilityAction: removes the user access to a specific protected page.
  • meta: contains detailed information, such as:
    • add_to_campaign_id: the campaign ID to add the contact to (only if type is “AddToCampaignAction”).
    • remove_from_campaign_id: the campaign ID to remove the contact from (only if type is “RemoveFromCampaignAction”).
    • post_to_url: the HTTP destination callback URL (only if type is “HttpPostAction”).
    • post_params: the HTTP parameters, in query form (?param=val&param2=val2…) (only if type is “HttpPostAction”).
  • email_template: (only if type is “EmailAction” or “CustomEmailAction”) containing:
    • additional_fields:
      • subject: the email’s subject.
      • from_name: the from name used as the sender.
      • from_email: the from email used as the sender.
    • content: the email’s full HTML body.