Use wide NPS API integration

With Ants & Apps platform you can connect NPS API with more than 4000 available apps, 600+ functional formulas to boost your productivity

Reference

  • feedback

    • Unsubscribe from the feedback

      This action unsubscribe from the feedback.new_or_modified webhook. When creating a request to this endpoint you need to provide your subscriber ID as a path parameter. This ID is the one returned in the subscription request.

      GETFeedbackUnsubscribe

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • subscriberId*integer

        subscriber Id provided in the response to the subscription request.

    • A you may have lots of feedback in different campaigns, it is recommended to filter feedback search by campaign_id, and use any of all the other enabled filters for this endpoint such as show only uncompleted feedback, filter by score type, along with a few more options as query parameters

      This action as you may have lots of feedback in different campaigns, it is recommended to filter feedback search by campaign_id, and use any of all the other enabled filters for this endpoint such as show only uncompleted feedback, filter by score type, along with a few more options as query parameters.
      When this call is made, it will return 100 results at a time and will require paginating through the results. To paginate, you would add a page parameter to the url. Example

      /feedback/{secret}?page[size]=30&page[number]=2

      Besides, you can search feedback within a specific time period by date queries in the URL. Date format accepted is yyyy-mm-dd. Examples
      • All feedback before a specific date
        /api/feedback{secret}?before_date=2018-01-23
      • All feedback after a specific date
        /api/feedback{secret}?after_date=2018-01-23
      • Feedback for a specific time period
        /api/feedback{secret}?before_date=2018-02-23&after_date=2018-01-23

      GETGetFeedback

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • emailstring

        Search for all feedback from a specific contact by using their email address.

      • campaigninteger

        The id of the campaign you'd like all feedback from.

      • scoreinteger

        Choose to get feedback with specific scores. Allowed values from 0 to 10.

      • typestring

        Get feedback based on type. Options are "promoter", "passive" or "detractor".

      • statusstring

        Add this parameter if you'd like to only view feedback that is either "open" or "closed".

      • followupstring

        Get feedback based on the actions already taken on them. Options are "replied", "forwarded" or "both".

      • before_datestring

        Use this parameter to get all feedback before a specific date. Example "2018-03-23".

      • after_datestring

        Use this parameter to get all feedback after a specific date. Example "2018-01-23".

      • stringinteger

        query string parameter for page size, or number of results per page.

    • Retrief a specific feedback received in your organization by providing the feedback id

      This action retrieves a specific feedback received in your organization by providing the feedback id.

      GETGetFeedbackById

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • feedback_id*integer

        The id of the feedback you'd like to retrieve.

    • By using this endpoint you will be able to forward a feedback internally, which is very useful in cases that could need further support from another department

      This action by using this endpoint you will be able to forward a feedback internally, which is very useful in cases that could need further support from another department. Required fields are the id of the feedback you're forwarding, and the email address of the recipient. Optionally you can send an additional message together with the forwarded feedback. Feedback can only be forwarded to one recipient at a time. Also have in mind that a feedback can only be forwarded if

      1. Feedback has not been replied yet.
      2. Feedback is not closed.

      There is also a flag (forward_and_close) you can send as true if you want the feedback co be closed after being forwarded.

      This forward email will be sent from the generic email address [email protected]

      POSTForwardFeedback

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • feedback_id*integer

        The id of the feedback you'd like to forward.

      Request body

      • to*string

        Email of the recipient.

      • forward_and_closeboolean

        flag to force the feedback to be closed after being forwarded.

      • messagestring

        The message you want to send as your reply.

    • By using this endpoint you will be able to follow-up with your users and reply to their feedback

      This action by using this endpoint you will be able to follow-up with your users and reply to their feedback. Required fields are the feedback_id to which you're replying to, the email address the reply is coming from, and the message you want to send. The from email must be an email that belongs to a member of the organization. You also have to option to cc or bcc other addresses in your reply. There's no limit to how many emails that can be included, but they'll need to be in a list. You cannot reply to a feedback that has already been replied or to feedback which is not in 'scored' or 'reviewed' state.

      POSTReplyFeedback

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • feedback_id*integer

        The id of the feedback you'd like to reply to.

      Request body

      • from*string

        Email of the user sending the reply.

      • message*string

        The message you want to send as your reply.

      • bccstring

        A list of emails you want to be bcc'd on the reply. Comma separated.

      • ccstring

        A list of emails you want to be cc'd on the reply. Comma separated.

    • Subscribe to the feedback

      This action subscribe to the feedback.new_or_modified webhook

      POSTFeedbackSubscribe

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      Request body

      • callbackUrl*string

        Example: https://myserver.com/send/callback/here

    • This endpoint will allow you to add a tag to your feedback and associate a sentiment to that tag, which can be 'positive' (green), 'neutral' (grey) or 'negative' (red)

      This action this endpoint will allow you to add a tag to your feedback and associate a sentiment to that tag, which can be 'positive' (green), 'neutral' (grey) or 'negative' (red). Required fields are the name of the new tag, and its sentiment. But remember that multiple tags with the same name cannot exist on the same feedback, even if their sentiment are different. For instance, 'price - positive' and 'price - neutral' cannot exist for one feedback at the same time, it's one or the other. Besides, this API call will fail if you try to add a tag to a closed feedback.

      POSTTagFeedback

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • feedback_id*integer

        The id of the feedback you'd like to tag.

      Request body

      • sentiment*string

        The category/sentiment to apply to your tag. It can be 'positive', 'neutral' or 'negative'.

      • tag*string

        Name of the new tag.

    • By calling to this endpoint you can send to the NPS platform the same info that we collect in the NPS web campaign when the pixel script is placed in the thankyou page of the purchase process

      This action by calling to this endpoint you can send to the NPS platform the same info that we collect in the NPS web campaign when the pixel script is placed in the thankyou page of the purchase process. This way you will be able to update financial information for a contact in the system, after a new purchase. For this endpoint to work is necessary that you have your Web NPS campaign activated in the NPS control panel.

      POSTConversionPixel

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • webcampaign_id*integer

        This is the ID of the web campaign associated with the info received in the pixel. You can find this field in the setup wizard for your web NPS campaign in the control panel. In the fifth step called "snippet" you have to search into the snippet itself for a substring like

        (window,document,["survey","reset","config","init","set","get","event","identify","track","page","screen","group","alias"],"2xqowMLdQanm1rv3/KrjY4GaOWaMRl6mg","referion");

        where the second field (in this case KrjY4GaOWaMRl6mg) is the webcampaign_id that you have to use to fill this parameter.

      Request body

      • amount*number

        Amount of the purchase, in euros. Just the number, no points, commas or currency.

      • email*string

        Email of the user that made the purchase.

      • namestring

        Name of the user that made the purchase. This field is optional, but it is highly recommended that you send it because it helps to build the contact profile in the system.

    • Using this API call will allow you to close an open feedback, or to reopen a closed one

      This action using this API call will allow you to close an open feedback, or to reopen a closed one.

      PUTCloseFeedback

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • feedback_id*integer

        The id of the feedback you'd like to remove.

      Request body

      • status*string

        new status for the feedback, options are 'open' or 'close'.

    • This action will permanently delete a piece of feedback by providing the feedback id, including its tags and internal notes, and the history of scores and reviews from that survey contact

      This action this action will permanently delete a piece of feedback by providing the feedback id, including its tags and internal notes, and the history of scores and reviews from that survey contact.

      DELETEDeleteFeedback

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • feedback_id*integer

        The id of the feedback you'd like to remove.

  • campaigns

    • Retrief all campaigns and their details including id, type, campaign name, status, original launch date, business/natural days, drip duration, reminder on/off, feedback forward, recurring schedule, current timezone, current template, current contact list

      This action retrieves all campaigns and their details including id, type, campaign name, status, original launch date, business/natural days, drip duration, reminder on/off, feedback forward, recurring schedule, current timezone, current template, current contact list.

      GETGetCampaigns

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • searchStringstring

        pass an optional search string for looking up campaign names.

    • This endpoint will retrieve current campaign metrics for a specific campaign within a organization, given its ID

      This action this endpoint will retrieve current campaign metrics for a specific campaign within a organization, given its ID. Optionally is possible to grab metrics for a specific time period by date queries in the URL. Date format accepted is yyyy-mm-dd. Examples

      • All metrics before a specific date
        /api/campaign/metrics/{secret}/123?before_date=02/11/2018
      • All metrics after a specific date
        /api/campaign/metrics/{secret}/123?after_date=25/12/2018
      • Campaign metrics for a specific time period
        /api/campaign/metrics/{secret}/123?before_date=02/11/2018&after_date=25/12/2018

      Score analysis values
      • From -100 to -1 => 'BAD NPS'
      • From 0 to 49 => 'GOOD NPS'
      • From 50 to 74 => 'EXCELLENT NPS'
      • From 75 to 100 => 'WORLD CLASS'
      GETGetCampaignsMetrics

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • campaign*integer

        Id of the campaign you want to retrieve metrics of.

      • before_datestring

        Use this parameter to get all feedback before a specific date. Example "2018-03-23".

      • after_datestring

        Use this parameter to get all feedback after a specific date. Example "2018-01-23".

    • Use this method to create and launch a new survey for the given email campaign

      This action use this method to create and launch a new survey for the given email campaign. If the campaign is active (it has an ongoing survey) this operation is not allowed and an error will be returned.

      GETLaunchSurvey

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • campaign_id*integer

        Id of the campaign.

      • new_only*boolean

        true if only new contacts in the list should be surveyed, false if the survey must be sent to all contacts in the list.

    • Create a new email NPS campaign

      This action create a new email NPS campaign. Creation of a campaign via the API requires an email template and a contact list to exist within your organization prior to campaign creation. No recurring schedule are allowed when creating campaigns via API, it can be done manually in the app after the campaign is created.

      POSTCreateCampaign

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      Request body

      • contact_list_id*integer

      • name*string

      • send_time*string

        Example: 2018-01-23 15:00:06

      • template_id*integer

      • due_datestring

        Example: 31/01/2021

      • footer_fontstring

        Example: josefin

      • footer_textstring

        Example: Footer text

      • handwriting_stylestring

        Example: Jane

      • header_fontstring

        Example: josefin

      • header_imagestring

        Example: http://app.thehandwriting.company/static/images/your_logo.png

      • header_textstring

        Example: Header text

      • header_typestring

        Example: Logo

      • insertsstring

        Example: $5 Starbucks gift card

      • notesstring

        Example: Campaign notes

      • paper_sizestring

        Example: A5

      • productstring

        Example: Advanced

      • recipientsstring

      • return_addressstring

      • textstring

        Example: Hello {{{first name}}},This is a test!

      • titlestring

        Example: My campaign

      • channel_guidsstring

      • descriptionstring

      • group_guidstring

      • namestring

      • business_daysboolean

        true if you want the survey to be sent only during business days, or false if you want natural days.

      • drip_daysinteger

        choose 0 if you want the survey to be sent as a whole in just one block, or choose the number of dripping days if you want to enable dripping.

      • feedback_fwdstring

      • timezonestring

        timezone you want to apply to the survey

  • replies

    • Retrieve all common replies in your organization

      This action retrieve all common replies in your organization. Results are paginated, although is not usual to have a large number of common replies. To paginate, you would add a page parameter to the url. Example

      /replies/{secret}?page[size]=30&page[number]=2
      .

      GETGetCommonReplies

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • stringinteger

        query string parameter for page size, or number of results per page.

    • Create a common reply within your organization

      This action create a common reply within your organization. Required fields are the name for the reply, the message which is the reply itself, and the category the reply will be saved under. If you choose a category name that does not exist within your organization, a new category will be created and store the common reply within it.

      POSTCreateCommonReply

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      Request body

      • category*string

        The name of the common reply category in which you would like the reply to be associated with.

      • message*string

        This is the main body of your common reply message.

      • name*string

        Name or title for this new common reply

    • This action will permanently delete a common reply within your organization

      This action this action will permanently delete a common reply within your organization.

      DELETEDeleteCommonReply

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • common_reply_id*integer

        The id of the common reply you'd like to remove.

  • contactlists

    • Retrief all contact lists and their details including id, name, context, status and creation date

      This action retrieves all contact lists and their details including id, name, context, status and creation date.

      GETGetContactLists

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • searchStringstring

        pass an optional search string for looking up contact lists names.

    • Remove a contact by its email

      This action remove a contact by its email. This action removes a contact from all contact lists. The contact’s data will still exist in the organization, but their email will simply be removed from the lists it was attached to.

      POSTRemoveContactByEmail

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      Request body

      • email*string

    • Remove a contact by its email

      This action remove a contact by its email. This action removes a contact from a contact list.

      POSTRemoveContactFromListByEmail

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • contactlist*string

        The id of the contact list that the contact will be removed from.

      Request body

      • email*string

    • Create a new contact list for your organization

      This action create a new contact list for your organization. This method just creates an empty contact list whose contacts should be added later. This list is not assigned to any campaign after its creation.

      POSTCreateContactlist

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      Request body

      • name*string

        name for the new contact list.

    • This removes a contact list from the organization

      This action this removes a contact list from the organization. The only parameter required for this action is the list id.

      DELETERemoveContactlist

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • contactlist*string

        the id of the contact list that the will be removed.

    • This removes a contact from a single contact list with no other implications

      This action this removes a contact from a single contact list with no other implications. The parameters required for this action are the list id and contact id.

      DELETERemoveContactFromContactlist

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • contactlist*string

        the id of the contact list that the contact will be removed from.

      • contact*string

        the id of the contact you would like removed from the list.

  • templates

    • Retrief all templates and their details including template id, name, context, type, used, reply_to, from, subject, logo, message, nps_question, optional_disclaimer, brand_color, button_shape, button_style, font_family, web_layout_style, creation date and language

      This action retrieves all templates and their details including template id, name, context, type, used, reply_to, from, subject, logo, message, nps_question, optional_disclaimer, brand_color, button_shape, button_style, font_family, web_layout_style, creation date and language.

      GETGetTemplates

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • searchStringstring

        pass an optional search string for looking up template names.

    • Create an email template for your organization NPS surveys

      This action create an email template for your organization NPS surveys. Note that when providing a logo, it must be data from a base64 encoded image.

      POSTCreateTemplate

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      Request body

      • from*string

        email account for the from field in email NPS surveys using this template.

      • logo*string

        Base64 encoded image data (only) representing the logo for your survey. It is also the logo they see when they respond to the survey with a score, located at the top of the survey.

      • message*string

        header message in email NPS surveys using this template.

      • name*string

        name for the new template.

      • nps_question*string

        main subject of this NPS survey, for instance "How likely would you recommend ACME Inc to other friends?"

      • reply_to*string

        email account for the reply_to field in NPS email surveys using this template.

      • subject*string

        Email subject in email NPS surveys using this template.

      • languagestring

        language code (ISO 639-1:2002). Default value "es". Idiomas soportados actualmente: 'ca' Catalá
        'hr' Croatian
        'cs' Czech
        'da' Danish
        'nl' Dutch
        'en' English
        'fi' Finnish
        'fr' French (France)
        'de' German
        'el' Greek
        'hi' Hindi
        'is' Icelandic
        'id' Indonesian
        'it' Italian
        'ja' Japanese
        'ko' Korean
        'pl' Polish
        'pt' Portuguese (Portugal)
        'ro' Romanian
        'ru' Russian
        'es' Spanish (Spain)
        'sv' Swedish
        'tr' Turkish
        'uk' Ukrainian
        'vi' Vietnamese

      • logo_linkstring

        Link associated to the logo image.

      • optional_disclaimerstring

        legal disclaimer at the footer of the email in email NPS surveys using this template.

      • thankyou_pageobject

      • typestring

        type of template, it can be for customers or for employees.

  • contacts

    • Retrief a specific contact in your organization by providing the contact id

      This action retrieves a specific contact in your organization by providing the contact id. This contact may belong to any number of contact lists within the system.

      GETGetContactById

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • contact*string

        the id of the contact you would like to get.

    • Retrief all contacts in your organization

      This action retrieves all contacts in your organization. You can also query by contact email to find particular contacts, or query by a contact list id to grab all contacts within a specific list. This endpoint returns paginated results, it will return 30 results at a time and will require paginating through the results.
      To paginate, you would add a page parameter to the url. Example

      /contacts/{secret}?page[size]=30&page[number]=2

      GETGetContacts

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • emailstring

        pass an optional email if you want to narrow down the search.

      • contact_listinteger

        pass an optional contact list id if you want to search within the contacts of a specific list.

      • stringinteger

        query string parameter for page size, or number of results per page.

    • This endpoint removes a contact for an organization

      This action this endpoint removes a contact for an organization. This is a delete action and all of the contact’s data and history will be removed from the organization. This method is useful when a final user requests to be forgotten by an organization as its is allowed in the new GDPR.

      POSTRemoveContact

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      Request body

      • email*string

    • This endpoint can be used to perform two actions with one command, first add a contact to a list (a campaign list) and then send them a survey

      This action this endpoint can be used to perform two actions with one command, first add a contact to a list (a campaign list) and then send them a survey. There's no need to specify a contact list as the contact is added to the list associated to the campaign. You can pass in as many attributes as you'd like along with your contact. These can be useful when filtering your NPS on the campaign dashboard. The minimum requirements for surveying a contact are the contact's email and the campaign id you're surveying them from. To set other settings such as distribution, forwarding, or Delivery Delay, these will need to be set within your campaign settings from the control panel. Depending on your throttle setting, your contact may not be surveyed if they have been recently surveyed (Survey Throttle setting can be found in your account settings). Note that if you're looking to survey contacts you've added to a list, please reference the "send-surveys" endpoint in the Campaigns section of this API.
      If you want to provide financial data in the attributes for this contact it's important that you name these fields as follows:

      • Total purchases => total_purchases
      • Total amount (from those purchases) => total_purchases_amount
      • Last purchase amount => last_purchase_amount
      • Last purchase date => last_purchase_date

      POSTSurveyContact

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • overwrite*integer

        flag to indicate that the contact must be updated (overwritten) if it already. If this is set to 0 and the contact already exists this call will throw an error with a 404 code.

      Request body

      • campaign_id*integer

        ID of the campaign you want to send the survey from.

      • email*string

        Email of the contact you'd like to survey.

      • attributes

        custom attributes asigned to this contact can be any number of arbitrary property/value pairs.

      • first_namestring

        Example: John

      • last_namestring

        Example: Doe

    • With this method, you can unsubscribe a contact and this will prevent the ability to survey them in the future

      This action with this method, you can unsubscribe a contact and this will prevent the ability to survey them in the future. The unsubscribe action will also cancel all future pending surveys that were scheduled for that contact, and it will affect that contact in all the lists that contact belongs to.

      POSTUnsubscribeContact

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      Request body

      • email*string

  • client

    • This endpoint will retrieve the financial metrics for the whole organization

      This action this endpoint will retrieve the financial metrics for the whole organization. Optionally is possible to filter results by campaign type:

      • "All", get the metrics for all campaigns, both web and email.
      • "Email", get the metrics only from email campaigns.
      • "Web", get the metrics only from the web campaign.

      • If there are no campaigns or there are not data collected for the existing campaigns, this method will return an empty result.

      GETGetFinancialMetrics

      Request parameters

      • Authorization*string

        This is where you'll provide your API key, after inserting the word 'Bearer' and a space.

      • Content-Type*string

        Must be "application/json".

      • secret*string

        Client secret provided when setting up OAuth2 authentication.

      • filterstring

        Get the metrics based on the type of the campaigns. Options are "all" (default), "email" or "web".