Skip to main content

Use the API key to connect to the Sitecore Send web API

Abstract

Learn how to pass a valid API key in requests to the Sitecore Send web API.

All API calls require authentication. This is essential for security reasons, but also for the API to identify the user who is making the call so that appropriate results are returned. You achieve authentication through the use of an API key.

You must pass a valid API key in each request to the Sitecore Send web API. This is a unique key for each account in our system that you use to integrate Sitecore Send with your favorite apps and/or your own applications. You can get your API key from the settings page in your account.

To obtain and use your API key:

  1. On the dashboard, click Account, and click Settings.

  2. In the menu on the left, click API key.

  3. On the API key page, click Copy or click Generate API key if you require a new key.

  4. Specify the key as a parameter in the query string of the requesting URL. For example:

     http://api.sitecoresend.io/v3/campaigns/create.xml?apikey=YOUR_API_KEY

    Important

    Keep your unique API key safe to avoid any unauthorized external access to your account.