This document is intended for programmers who want to write client applications that can interact with Shape’s system and features. Apps can read and write to the resources and mirror some of the most popular features available in Shape such as creating leads, updating and retrieving information about leads, updating and retrieving statuses, and creating calendar events. Depending on your app’s use case, you can choose from our various APIs and implement the features accordingly.
With each release, we add additional APIs and enhancements to meet the needs of our customers. For more information on recent and upcoming API updates, visit our status updates page.
When using Shape Software API you are agreeing to follow all Shape Software Guidelines and Policies. Policies are described as but not limited to Acceptable Use, Terms of Service, Security, Privacy, and any additional polices or contracts agreed upon but not listed here. Any violation of these policies will result in immediate termination of your Shape Software API access and may result in legal action.
This document assumes that you understand the general ideas behind the data protocol. All APIs under the Shape API are based on REST architecture and are accessed via HTTP at specified URLs. The base URL for all requests is https://secure-api.setshape.com/api. The complete URL varies depending on the endpoint of the resource being accessed. For instance, you can add leads via a POST request to this URL: https://secure-api.setshape.com/api/add/new/lead.
This section contains some information to help you get started with the Shape API. You’ll need a Shape Software account. If you already have an account with Shape, you can visit the API Integrations Page to retrieve the API Authorization Key which is needed as a header.
Field names can be found within your CRM System’s settings pages under: Settings > Marketing Sources > Edit Any Marketing Source > Campaign Source Post URL Instructions.
After navigating to the marketing sources settings page and opening up a campaign, scroll to the bottom of the page to the “Campaign Source Post URL Instructions” section. Here, you will find a searchable table with a breakdown of all of the field names available for use. These field names can also be exported to a CSV via the “Export” dropdown.
