How can we help?

Find solutions and learn more about the different features in StoneShot

API Documentation

Integrate StoneShot data with your website, CRM, CMS and much more to implement smarter marketing strategies and give your clients a personalised experience. Here is everything you need to get started.

Getting started

Authentication

The StoneShot API currently supports authentication via an API Key using basic HTTP Authentication. You can generate your API key from the Integrations page when logged into your StoneShot account. When making an API request you will provide your API key as the password, the username value can be left empty as it is not used for authentication.

To quickly test calls to the API with your API key, you can use a tool such as cURL via the command line. You’ll find cURL examples for each method in the following guide. Here’s an example of a cURL request to the ping endpoint to check the current status of the API.

curl -L -X GET \
  "https://api.stoneshot.com/v1/ping" \ 
  -H "Authorization: Basic [PASSWORD]"  

Requests

Requests to the StoneShot API are formed based on a number of rules and parameters. Full details of the supported parameters for each request are detailed in the documentation below. Here is a description of each of the key pieces that make up a request to the API.

Root

All requests to the StoneShot API will stem from the API root:

https://api.stoneshot.com/v1/
Path parameters

Path parameters are required when targeting a specific record, here’s an example of a request endpoint to retrieve a specific list, in this case [list_id] is the path parameter.

https://api.stoneshot.com/v1/lists/[list_id]
Query parameters

Query parameters are used in requests to the API to restrict the properties returned in a given request by explicitly including those fields as part of the ‘select’ query parameter. By default the common fields will be returned as part of any request, the ‘select’ query parameter can be included if the defaults do not cover your needs. A ‘select’ query string should be included for each field required.

Here’s an example of the ‘select’ query parameter being used to only bring back the name field when retrieving all lists.

https://api.stoneshot.com/v1/lists?select=name

Query parameters can also be used to filter, sort and limit results. Examples of using these query parameters can be found within each request detail in the following documentation. Here’s an example of a request to get no more than 50 lists with ‘StoneShot’ in the name sorted by most recently created.

https://api.stoneshot.com/v1/lists?name=stoneshot&count=50&sort_by=-create_date_utc
Body parameters

Body parameters are often required for POST and PATCH requests to the StoneShot API. The body of the request should be in JSON format, examples of body parameters can be found in the cURL snippets for each of the requests in the following documentation. Here’s a short example of the body required to create a new static list.

{
  "name": "StoneShot API List",
  "tags":[
    {
      "name": "api"
    }
  ],
  "teams":[
    {
      "name": "StoneShot"
    }
  ]
}
Responses

API responses are served in JSON (JavaScript Object Notation) format. This includes both success and error responses.

Example responses are given for each request in the following documentation.

Response status codes

Each request to the API will return a response partnered by a HTTP status code representing the status of the request. A successful request will return a HTTP Status 200 response and the relevant response object. For example when creating a list via the API, on successful create you will receive a HTTP status 200 and the newly created list object in the response.

Requests that fail will return the relevant HTTP status code along with a custom response code and message which will provide more detail on the error itself. Here’s an example of an error returned when an invalid API key is offered.

{  
  "code": 104,
  "message": "Invalid key"
}

Rate limiting

The StoneShot API endpoints are subject to rate limiting based on the number of requests over a period of time. The default rate is limit 10,000 requests every 60 minutes.

Requests made to the API once the limit has been reached, will return a response such as below, the response headers will include additional information on the your rate limit and the time at which it is reset. If you find that you are regularly hitting the limit, please contact StoneShot support to discuss your options.

X-Rate-Limit-Limit: 10000
X-Rate-Limit-Remaining: 0
X-Rate-Limit-Reset: "17/01/2020 17:43:25"

{
  "code": 114,
  "message": "Too many requests in time frame; check RateLimit headers"
}

Contact matching

A number of the API requests will involve retrieving or updating an existing contact record. The API supports a number of individual StoneShot fields in order to determine which contact to match on, these fields being:

  • Member Url Id
  • StoneShot Contact Id
  • CRM ID (SalesforceId, Microsoft Dynamics Id, Siebel Id or Unique User Id)
  • Email Address (Cannot be used as a path parameter)

When one of the seven identifiers is required in a request to the API, it should be passed through using the ‘identifier’ keyword. The matching criteria will then be determined automatically as part of the request.

Campaigns

Retrieve your contacts who have been sent a campaign or send a campaign to your contacts.

Get campaign contacts

More

Less

GET/campaigns/{campaign_id}/contacts

Get contacts who have been sent a specified campaign.

Path parameters
campaign_id
The unique StoneShot campaign id.
Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
emailtitlefirst_namelast_namecompanycreate_date_utccontact_idlast_active_utc
Other fields
middle_namewebsitejob_titletelephonetelephone_extmobile_numberhome_numberaddress_1address_2address_3address_4citycountypostcodecountryopt_incustom_1prefer_htmlcreate_date_utcis_bouncesalesforce_account_idsalesforce_owner_iddouble_opt_in_statusunique_user_idsalesforce_idsiebel_iddynamics_id
count
The number of records to return. The default value is 1000.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is contact_id descending.
contact_id
Restrict results based on a unique StoneShot contact id.
email
Restrict results based on contact email address.
title
Restrict results based on contact title.
first_name
Restrict results based on contact first name.
last_name
Restrict results based on contact last name.
company
Restrict results based on contact company.
job_title
Restrict results based on contact job title.
city
Restrict results based on contact city.
county
Restrict results based on contact county.
country
Restrict results based on contact country.
salesforce_id
Restrict results based on contact salesforce id.
siebel_id
Restrict results based on contact siebel id.
dynamics_id
Restrict results based on contact microsoft dynamics id.
unique_user_id
Restrict results based on contact unique external user id.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/campaigns/[campaign_id]/contacts" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "contacts": [
    {
      "contact_id": 0,
      "email": "string",
      "title": "string",
      "first_name": "string",
      "last_name": "string",
      "company": "string",
      "create_date_utc": "2019-06-13T15:00:45Z",
      "last_active_utc": "2020-08-06T15:03:10Z"
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Add contact to campaign

More

Less

PATCH/campaigns/{campaign_id}/contacts

Send a contact an email by adding them to an existing campaign using any of the unique contact ids.

Path parameters
campaign_id
The unique StoneShot campaign id.
Body parameters
member_url_idstring
The contact member url (optional)
salesforce_idstring
The contact salesforce id (optional).
dynamics_idstring
The contact microsoft dynamics id (optional).
siebel_idstring
The contact siebel id (optional).
unique_user_idstring
The contact unique external user id (optional).
contact_idinteger
The unique StoneShot contact id (optional).
emailstring
The contact email address (optional).
cURL example
curl -L -X PATCH \
  "https://api.stoneshot.com/v1/campaigns/[campaign_id]/contacts"
  -H "Authorization: Basic [PASSWORD]" \
  -d "{"email": "string}"

Success response
{
  "contacts": [
    {
      "contact_id": 0,
      "email": "string",
      "title": "string",
      "first_name": "string",
      "last_name": "string",
      "company": "string",
      "create_date_utc": "2019-06-13T15:00:45Z",
      "last_active_utc": "2020-08-06T15:03:10Z"
    }
  ]
}

Error response
{
  "code": "117",
  "message": "No data found"
}

Contacts

Retrieve your StoneShot contacts information, create or update contacts and more.

Get contacts

More

Less

GET/contacts

Retrieve contacts associated with your account.

Request parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
emailtitlefirst_namelast_namecompanycreate_date_utccontact_idlast_active_utc
Other fields
middle_namewebsitejob_titletelephonetelephone_extmobile_numberhome_numberaddress_1address_2address_3address_4citycountypostcodecountryopt_incustom_1prefer_htmlcreate_date_utcis_bouncesalesforce_account_idsalesforce_owner_iddouble_opt_in_statusunique_user_idsalesforce_idsiebel_iddynamics_idsegments.segment_idsegments.namesegments.dynamic_from_emailsegments.dynamic_from_namesegments.segmentation.namesegments.segmentation.segmentation_idemail_preferences.segment_idemail_preferences.nameemail_preferences.segmentation.nameemail_preferences.segmentation.segmentation_idevents.segment_idevents.nameevents.segmentation.nameevents.segmentation.segmentation_iddocument_preferences.segment_iddocument_preferences.namedocument_preferences.segmentation.namedocument_preferences.segmentation.segmentation_id
count
The number of records to return. The default value is 100.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is contact_id descending.
email
Restrict results based on the email address.
title
Restrict results based on the title.
first_name
Restrict results based on the first name.
last_name
Restrict results based on the last name.
company
Restrict results based on the company.
job_title
Restrict results based on the job title.
city
Restrict results based on the city.
county
Restrict results based on the county.
country
Restrict results based on the country.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/contacts" \ 
  -H "Authorization: Basic [PASSWORD]"  

Success response
{
  "contacts": [
    {
      "contact_id": 0,
      "email": "string",
      "title": "string",
      "first_name": "string",
      "last_name": "string",
      "company": "string",
      "create_date_utc": "2020-01-09T15:12:17Z",
      "last_active_utc": "2020-01-09T15:12:17Z"
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Create contact

More

Less

POST/contacts

Create a new contact against your account.

Body parameters
emailstring
The email address of the contact.
titlestring
The title of the contact.
first_namestring
The first name of the contact
last_namestring
The last name of the contact
job_titlestring
The job title of the contact.
companystring
The company of the contact.
opt_inboolean
The opt-in status of the contact.
prefer_htmlboolean
The preferred email format for the contact to receive.
address_1string
The address line 1 of the contact.
address_2string
The address line 2 of the contact.
address_3string
The address line 3 of the contact.
address_4string
The address line 4 of the contact.
citystring
The city of the contact.
countystring
The county of the contact.
countrystring
The country of the contact.
postcodestring
The postcode of the contact.
telephonestring
The telephone of the contact.
telephone_extstring
The telephone extension of the contact.
mobile_numberstring
The mobile telephone number of the contact.
home_numberstring
The home telephone number of the contact.
faxstring
The fax number of the contact.
websitestring
The website of the contact.
unique_user_idstring
The external unique user id of the contact.
salesforce_idstring
The salesforce id of the contact.
siebel_idstring
The siebel id of the contact.
microsoft_dynamics_idstring
The microsoft dynamics id of the contact.
custom_1string
The custom 1 of the contact.
segmentationsobject
The segmentation values for the contact.
email_preferencesobject
The email preference values for the contact.
eventsobject
The event session statuses for the contact.
document_preferencesobject
The document preference values for the contact.
content_preferencesobject
The content preference values for the contact.
custom_fieldsobject
The custom field values for the contact.
cURL example
curl -L -X POST \
  "https://api.stoneshot.com/v1/contacts" \ 
  -H "Authorization: Basic [PASSWORD]" \
  -d "{"email": "string", "first_name: "string", "last_name: "string"}"

Success response
{
  "contact": {
    "contact_id": 0,
    "email": "string",
    "title": "string",
    "first_name": "string",
    "last_name": "string",
    "company": "string",
    "create_date_utc": "2020-01-09T15:12:17Z",
    "last_active_utc": "2020-01-09T15:12:17Z"
  }
}

Error response
{
  "code": "119",
  "message": "Invalid email address"
}

Get contact

More

Less

GET/contacts/{identifier}

Get information for a specific contact record in your account.

Path parameters
identifier
A unique identifier for the contact. See contact matching for a list of the supported identifiers.
Request parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
emailtitlefirst_namelast_namecompanycreate_date_utccontact_idlast_active_utc
Other fields
middle_namewebsitejob_titletelephonetelephone_extmobile_numberhome_numberaddress_1address_2address_3address_4citycountypostcodecountryopt_incustom_1prefer_htmlcreate_date_utcis_bouncesalesforce_account_idsalesforce_owner_iddouble_opt_in_statusunique_user_idsalesforce_idsiebel_iddynamics_idsegments.segment_idsegments.namesegments.dynamic_from_emailsegments.dynamic_from_namesegments.segmentation.namesegments.segmentation.segmentation_idemail_preferences.segment_idemail_preferences.nameemail_preferences.segmentation.nameemail_preferences.segmentation.segmentation_idevents.segment_idevents.nameevents.segmentation.nameevents.segmentation.segmentation_iddocument_preferences.segment_iddocument_preferences.namedocument_preferences.segmentation.namedocument_preferences.segmentation.segmentation_id
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/contacts/[identifier]" \ 
  -H "Authorization: Basic [PASSWORD]"  

Success response
{
  "contact": {
    "contact_id": 0,
    "email": "string",
    "title": "string",
    "first_name": "string",
    "last_name": "string",
    "company": "string",
    "create_date_utc": "2020-01-09T15:12:17Z",
    "last_active_utc": "2020-01-09T15:12:17Z"
  }
}

Error response
{
  "code": "117",
  "message": "No data found"
}

Update contact

More

Less

PATCH/contacts/{identifier}

Update a contact record in your account.

Path parameters
identifier
A unique identifier for the contact. See contact matching for a list of the supported identifiers.
Body parameters
emailstring
The email address of the contact.
titlestring
The title of the contact.
first_namestring
The first name of the contact
last_namestring
The last name of the contact
job_titlestring
The job title of the contact.
companystring
The company of the contact.
opt_inboolean
The opt-in status of the contact.
prefer_htmlboolean
The preferred email format for the contact to receive.
address_1string
The address line 1 of the contact.
address_2string
The address line 2 of the contact.
address_3string
The address line 3 of the contact.
address_4string
The address line 4 of the contact.
citystring
The city of the contact.
countystring
The county of the contact.
countrystring
The country of the contact.
postcodestring
The postcode of the contact.
telephonestring
The telephone of the contact.
telephone_extstring
The telephone extension of the contact.
mobile_numberstring
The mobile telephone number of the contact.
home_numberstring
The home telephone number of the contact.
faxstring
The fax number of the contact.
websitestring
The website of the contact.
unique_user_idstring
The external unique user id of the contact.
salesforce_idstring
The salesforce id of the contact.
siebel_idstring
The siebel id of the contact.
microsoft_dynamics_idstring
The microsoft dynamics id of the contact.
custom_1string
The custom 1 of the contact.
segmentationsobject
The segmentation values for the contact.
email_preferencesobject
The email preference values for the contact.
eventsobject
The event session statuses for the contact.
document_preferencesobject
The document preference values for the contact.
content_preferencesobject
The content preference values for the contact.
custom_fieldsobject
The custom field values for the contact.
cURL example
curl -L -X PATCH \
  "https://api.stoneshot.com/v1/contacts/[identifier]" \ 
  -H "Authorization: Basic [PASSWORD]" \
  -d "{"email": "string", "first_name: "string", "last_name: "string"}"

Success response
{
  "contact": {
    "contact_id": 0,
    "email": "string",
    "title": "string",
    "first_name": "string",
    "last_name": "string",
    "company": "string",
    "create_date_utc": "2020-01-09T15:12:17Z",
    "last_active_utc": "2020-01-09T15:12:17Z"
  }
}

Error response
{
  "code": "117",
  "message": "No data found"
}

Content distribution system

Your StoneShot content preferences, used for managing contact content preferences.

Get content preferences

More

Less

GET/content-preferences

Retrieve all content preferences against your account.

Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
content_tag_iddisplay_ordertag.tag_idtag.name
Other fields
enabledvisiblegroup_iddescription
count
The number of records to return. The default value is 100.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is id descending.
name
Restrict results based on the content preference name.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/content-preferences" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "content_preferences": [
    {
      "content_tag_id": 0,      
      "display_order": 0,
      "tag": {
        "tag_id": 0,
        "name": "string"
      }
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Contact custom fields

Your StoneShot contact custom fields, used for storing custom contact information.

Get contact custom fields

More

Less

GET/custom-fields

Retrieve all contact custom fields against your account.

Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
custom_field_idnamedisplay_namedisplay_ordercreated_at_utc
count
The number of records to return. The default value is 100.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is id descending.
name
Restrict results based on the custom field name.
display_name
Restrict results based on the custom field display name.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/custom-fields" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "custom_fields": [
    {
      "custom_field_id": 0,
      "name": "string",
      "display_name": "string",	         
      "display_order": 0,
      "created_at_utc": "2020-01-17:43:25Z"      
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Document distribution system

Your StoneShot fund document preferences, used for managing contact fund document preferences.

Get document preferences

More

Less

GET/document-preferences

Retrieve all document preferences against your account.

Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
document_fund_idnamerange.range_idrange.namedocuments.document_iddocuments.external_iddocuments.namedocuments.urldocuments.last_updated_utcdocuments.subscribed_iddocuments.unsubscribed_id
Other fields
documents.system_namedocuments.document_type_iddocuments.isindocuments.sedoldocuments.region_iddocuments.currency_iddocuments.format_iddocuments.alt_namedocuments.description
count
The number of records to return. The default value is 100.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is document_fund_id descending.
name
Restrict results based on the document fund name.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/document-preferences" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "document_preferences": [
    {
      "document_fund_id": 2510,
      "name": "PAICR_2018",
      "url": null,
      "subscribed_id": null,
      "unsubscribed_id": null,
      "last_updated_utc": "2018-09-27T15:27:25Z",
      "range": null,
      "documents": [
        {
          "document_id": 11446,
          "name": "StoneShot_MA-TheGood-TheBad-TheUgly_BOSTON",
          "url": "",
          "last_updated_utc": "2018-09-27T15:26:38Z",
          "external_id": null,
          "subscribed_id": 457506,
          "unsubscribed_id": 457507
        }
      ]
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Email preferences

Your StoneShot email preferences, used for managing contact preferences.

Get email preferences

More

Less

GET/email-preferences

Retrieve all email preferences against your account.

Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
segmentation_idnamedisplay_ordersegments.segment_idsegments.namesegments.display_order
count
The number of records to return. The default value is 100.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is segmentation_id descending.
name
Restrict results based on the email preference name.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/email-preferences" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "email_preferences": [
    {
      "segmentation_id": 0,
      "name": "string",      
      "display_order": 0,
      "segments": [
        {
          "segment_id": 0,          
          "name": "string",
          "display_order": 0
        },
        {
          "segment_id": 0,          
          "name": "string",
          "display_order": 0
        }
      ]
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Events

Your StoneShot events can be managed and queried.

Get events

More

Less

GET/events

Retrieve events associated with your account.

Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
namesummarydescriptioncreate_date_utcupdate_date_utcteams.nametags.namecustom_fields.custom_field_idcustom_fields.display_name
Other fields
event_idtypeurlsalesforce_campaign_idteams.team_idtags.tag_idcustom_fields.namecustom_fields.order_by
count
The number of records to return. The default value is 100.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is event_id descending.
name
Restrict results based on the event name.
tag
Restrict results based on events with a given tag.
team
Restrict results based on events with a given team.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/events" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "events": [
    {
        "name": "string",
        "summary": "string",
        "description": "string",
        "create_date_utc": "2020-10-07T08:27:25Z",
        "update_date_utc": "2020-10-07T08:27:25Z",
        "tags": [],
        "teams": [],
        "custom_fields": []
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Get event

More

Less

GET/events/{event_id}

Get information about a specific event in your account.

Path parameters
event_id
The unique StoneShot event id.
Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
namesummarydescriptioncreate_date_utcupdate_date_utcteams.nametags.namecustom_fields.custom_field_idcustom_fields.display_name
Other fields
template_idupdate_date_utcb_subjectreply_to_addressencodingteams.team_idtags.tag_idlist.external_idlist.update_date_utc
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/events/[event_id]" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "event": {
    "name": "string",
    "summary": "string",
    "description": "string",
    "create_date_utc": "2020-06-23T16:12:18Z",
    "update_date_utc": "2020-06-23T16:12:18Z",
    "tags": [],
    "teams": [],
    "custom_fields": []
  }
}

Error response
{
  "code": "117",
  "message": "No data found"
}

Get event sessions

More

Less

GET/events/{event_id}/sessions

Retrieve sessions in an event associated with your account.

Path parameters
event_id
The unique StoneShot event id.
Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
locationdescriptionstart_datetags.namecustom_field_values.custom_field_idcustom_field_values.text_contentstatuses.namestatuses.countstatuses.segment_idvenue.venue_idvenue.namevenue.cityspeaker.speaker_idspeaker.namespeaker.location
Other fields
session_idend_datearrive_datesalesforce_campaign_idtags.tag_id
count
The number of records to return. The default value is 100.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is session_id descending.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/events/[event_id]/sessions" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "sessions": [
    {
      "location": "string",
      "description": "string",
      "start_date": "2020-10-07T08:27:25",
      "custom_field_values": [],
      "tags": [],
      "statuses": [],
      "venue": [],
      "speaker": []
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Get event session

More

Less

GET/events/{event_id}/sessions/{session_id}

Get information about a specific session in an event in your account.

Path parameters
event_id
The unique StoneShot event id.
session_id
The unique StoneShot session id.
Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
locationdescriptionstart_datetags.namecustom_field_values.custom_field_idcustom_field_values.text_contentstatuses.namestatuses.countstatuses.segment_idvenue.venue_idvenue.namevenue.cityspeaker.speaker_idspeaker.namespeaker.location
Other fields
session_idend_datearrive_datesalesforce_campaign_idtags.tag_id
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/events/[event_id]/sessions/[session_id]" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "session": {
    "location": "string",
    "description": "string",
    "start_date": "2020-06-23T16:12:18",
    "custom_field_values": [],
    "tags": [],
    "statuses": [],
    "venue": [],
    "speaker": []
  }
}

Error response
{
  "code": "117",
  "message": "No data found"
}

Get event session contacts

More

Less

GET/events/{event_id}/sessions/{session_id}/contacts

Get contacts who are associated to a specific session in an event in your account.

Path parameters
event_id
The unique StoneShot event id.
session_id
The unique StoneShot session id.
Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
emailfirst_namelast_namecompanycontact_idstatus
Other fields
unique_user_idsalesforce_idsiebel_iddynamics_id
count
The number of records to return. The default value is 1000.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is contact_id descending.
contact_id
Restrict results based on a unique StoneShot contact id.
email
Restrict results based on contact email address.
first_name
Restrict results based on contact first name.
last_name
Restrict results based on contact last name.
company
Restrict results based on contact company.
salesforce_id
Restrict results based on contact salesforce id.
siebel_id
Restrict results based on contact siebel id.
dynamics_id
Restrict results based on contact microsoft dynamics id.
unique_user_id
Restrict results based on contact unique external user id.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/events/[event_id]/sessions/[session_id]/contacts" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "contacts": [
    {
      "contact_id": 0,
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "company": "string",
      "status": "string"
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Get speaker

More

Less

GET/events/speakers

Retrieve event speakers associated with your account.

Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
namejob_titlelocation
Other fields
speaker_idphoto_urldescriptionprofile_url
count
The number of records to return. The default value is 100.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is speaker_id descending.
name
Restrict results based on the speaker name.
location
Restrict results based on a location.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/events/speakers" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "speakers": [
    {
      "name": "string",
      "job_title": "string",
      "location": "string"
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Get speaker

More

Less

GET/events/speakers/{speaker_id}

Get information about a specific event speaker in your account.

Path parameters
speaker_id
The unique StoneShot speaker id.
Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
namejob_titlelocation
Other fields
speaker_idphoto_urldescriptionprofile_url
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/events/speakers/[speaker_id]" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "speaker": {
    "name": "string",
    "job_title": "string",
    "location": "string"
  }
}

Error response
{
  "code": "117",
  "message": "No data found"
}

Get venues

More

Less

GET/events/venues

Retrieve event venues associated with your account.

Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
nameaddress_1address_2address_3address_4citycountrypostcodecapacityoverbook
Other fields
venue_idcountyphoto_urlmap_urlemailtelephonecontactdescriptionlatitudelongitude
count
The number of records to return. The default value is 100.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is venue_id descending.
name
Restrict results based on the venue name.
city
Restrict results based on a city.
country
Restrict results based on a country.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/events/venues" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "venues": [
    {
      "name": "string",
      "address_1": "string",
      "address_2": "string",
      "address_3": "string",
      "address_4": "string",
      "city": "string",
      "country": "string",
      "postcode": "string",
      "capacity": 0,
      "overbook": 0
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Get venue

More

Less

GET/events/venues/{venue_id}

Get information about a specific event venue in your account.

Path parameters
venue_id
The unique StoneShot venue id.
Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
nameaddress_1address_2address_3address_4citycountrypostcodecapacityoverbook
Other fields
venue_idcountyphoto_urlmap_urlemailtelephonecontactdescriptionlatitudelongitude
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/events/venues/[venue_id]" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "venue": {
    "name": "string",
    "address_1": "string",
    "address_2": "string",
    "address_3": "string",
    "address_4": "string",
    "city": "string",
    "country": "string",
    "postcode": "string",
    "capacity": 0,
    "overbook": 0
  }
}

Error response
{
  "code": "117",
  "message": "No data found"
}

Lists

Your StoneShot lists, both dynamic and static can be managed and queried.

Get lists

More

Less

GET/lists

Retrieve lists associated with your account.

Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
list_idnametypeteams.nametags.namecreate_date_utc
Other fields
external_idupdate_date_utcteams.team_idtags.tag_id
count
The number of records to return. The default value is 100.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is list_id descending.
name
Restrict results based on the list name.
tag
Restrict results based on lists with a given tag.
team
Restrict results based on lists with a given team.
type
Restrict results to ‘static’ or ‘dynamic’ lists only by including either keyword. Not including this parameter will return both static and dynamic lists.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/lists" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "lists": [
    {
      "name": "string",
      "create_date_utc": "2020-10-07T08:27:25Z",
      "tags": [],
      "teams": [],
      "type": "string"
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Create list

More

Less

POST/lists

Create a new static list against your account.

Body parameters
namestring
The name of your list.
tagsobject
The tags to be assigned to your list.
teamsobject
The teams to be assigned to your list.
cURL example
curl -L -X POST \
  "https://api.stoneshot.com/v1/lists" \ 
  -H "Authorization: Basic [PASSWORD]" \
  -d '{"name": "string"}'

Success response
{
  "list": {
    "name": "string",
    "create_date_utc": "2020-10-16T12:06:34Z",
    "tags": [],
    "teams": [],
    "type": "string"
  }
}

Error response
{
  "code": "118",
  "message": "Required parameter/s not supplied"
}

Get list

More

Less

GET/lists/{list_id}

Get information for a specific list in your account.

Path parameters
list_id
The unique StoneShot list id.
Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
list_idnametypeteams.nametags.namecreate_date_utc
Other fields
external_idupdate_date_utcteams.team_idtags.tag_id
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/lists/[list_id]" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "list": {
    "name": "string",
    "create_date_utc": "2020-06-23T16:12:18Z",
    "tags": [],
    "teams": [],
    "type": "string"
  }
}

Error response
{
  "code": "117",
  "message": "No data found"
}

Get list contacts

More

Less

GET/lists/{list_id}/contacts

Get contact information for all contacts that form part of a specific list.

Path parameters
list_id
The unique StoneShot list id.
Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
emailtitlefirst_namelast_namecompanycreate_date_utccontact_idlast_active_utc
Other fields
middle_namewebsitejob_titletelephonetelephone_extmobile_numberhome_numberaddress_1address_2address_3address_4citycountypostcodecountryopt_incustom_1prefer_htmlcreate_date_utcis_bouncesalesforce_account_idsalesforce_owner_iddouble_opt_in_statusunique_user_idsalesforce_idsiebel_iddynamics_id
count
The number of records to return. The default value is 1000.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is contact_id descending.
contact_id
Restrict results based on a unique StoneShot contact id.
email
Restrict results based on contact email address.
title
Restrict results based on contact title.
first_name
Restrict results based on contact first name.
last_name
Restrict results based on contact last name.
company
Restrict results based on contact company.
job_title
Restrict results based on contact job title.
city
Restrict results based on contact city.
county
Restrict results based on contact county.
country
Restrict results based on contact country.
salesforce_id
Restrict results based on contact salesforce id.
siebel_id
Restrict results based on contact siebel id.
dynamics_id
Restrict results based on contact microsoft dynamics id.
unique_user_id
Restrict results based on contact unique external user id.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/lists/[list_id]/contacts" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "contacts": [
    {
      "contact_id": 0,
      "email": "string",
      "title": "string",
      "first_name": "string",
      "last_name": "string",
      "company": "string",
      "create_date_utc": "2020-07-14T13:16:00Z"
    },	
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Add contact to list

More

Less

PATCH/lists/{list_id}/contacts/add

Add an existing contact to a specific static list.

Path parameters
list_id
The unique StoneShot list id.
Body parameters
member_url_idstring
The contact member url (optional)
salesforce_idstring
The contact salesforce id (optional).
dynamics_idstring
The contact microsoft dynamics id (optional).
siebel_idstring
The contact siebel id (optional).
unique_user_idstring
The contact unique external user id (optional).
contact_idinteger
The unique StoneShot contact id (optional).
emailstring
The contact email address (optional).
cURL example
curl -L -X PATCH \
  "https://api.stoneshot.com/v1/lists/[list_id]/contacts/add"
  -H "Authorization: Basic [PASSWORD]" \
  -d "{"email": "string}"

Success response
{
  "contacts": [
    {
      "contact_id": 0,
      "email": "string",
      "title": "string",
      "first_name": "string",
      "last_name": "string",
      "company": "string",
      "create_date_utc": "2017-07-27T17:34:51Z"
    }
  ]
}

Error response
{
  "code": "117",
  "message": "No data found"
}

Remove contact from list

More

Less

PATCH/lists/{list_id}/contacts/remove

Remove a contact from a specific static list.

Path parameters
list_id
The unique StoneShot list id.
Body parameters
member_url_idstring
The contact member url (optional)
salesforce_idstring
The contact salesforce id (optional).
dynamics_idstring
The contact microsoft dynamics id (optional).
siebel_idstring
The contact siebel id (optional).
unique_user_idstring
The contact unique external user id (optional).
contact_idinteger
The unique StoneShot contact id (optional).
emailstring
The contact email address (optional).
cURL example
curl -L -X PATCH \
  "https://api.stoneshot.com/v1/lists/[list_id]/contacts/remove"
  -H "Authorization: Basic [PASSWORD]" \
  -d "{"email": "string}"

Success response
{
  "contacts": [
    {
      "contact_id": 0,
      "email": "string",
      "title": "string",
      "first_name": "string",
      "last_name": "string",
      "company": "string",
      "create_date_utc": "2017-07-27T17:34:51Z"
    }
  ]
}

Error response
{
  "code": "117",
  "message": "No data found"
}

Ping

Check the StoneShot API status.

Ping request

More

Less

GET/ping

Ping the StoneShot API to return the current status.

cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/ping" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "code": "100",
  "message": "Success"
}

Segmentation

Your StoneShot segmentation, a powerful feature for segmenting contacts.

Get segmentation

More

Less

GET/segmentations

Retrieve all segmentation against your account.

Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
segmentation_idnamedisplay_ordersegments.segment_idsegments.namesegments.display_order
count
The number of records to return. The default value is 100.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is segmentation_id descending.
name
Restrict results based on the segmentation name.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/segmentations" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "segmentations": [
    {
      "segmentation_id": 0,
      "name": "string",      
      "display_order": 0,
      "segments": [
        {
          "segment_id": 0,          
          "name": "string",
          "display_order": 0
        },
        {
          "segment_id": 0,          
          "name": "string",
          "display_order": 0
        }
      ]
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Templates

Your StoneShot templates can be managed and queried.

Get templates

More

Less

GET/templates

Retrieve templates associated with your account.

Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
namesubjectfrom_namefrom_emailteams.nametags.namecreate_date_utc
Other fields
template_idupdate_date_utcb_subjectreply_to_addressencodingteams.team_idtags.tag_id
count
The number of records to return. The default value is 100.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is template_id descending.
name
Restrict results based on the template name.
tag
Restrict results based on templates with a given tag.
team
Restrict results based on templates with a given team.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/templates" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "templates": [
    {
      "name": "string",
      "create_date_utc": "2020-10-07T08:27:25Z",
      "tags": [],
      "teams": [],
      "subject": "string",
      "from_name": "string",
      "from_email": "string"
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Get template

More

Less

GET/templates/{template_id}

Get information for a specific template in your account.

Path parameters
template_id
The unique StoneShot template id.
Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
namesubjectfrom_namefrom_emailhtml_share_linktext_share_linkteams.nametags.namecreate_date_utclist.list_idlist.namelist.typelist.create_date_utc
Other fields
template_idupdate_date_utcb_subjectreply_to_addressencodingteams.team_idtags.tag_idlist.external_idlist.update_date_utc
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/templates/[template_id]" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "template": {
    "name": "string",
    "html_share_link": "string",
    "text_share_link": "string",
    "create_date_utc": "2020-06-23T16:12:18Z",
    "tags": [],
    "teams": [],
    "subject": "string",
    "from_name": "string",
    "from_email": "string",
    "list": {
        "list_id": 0,
        "name": "string",
        "create_date_utc": "2020-06-23T16:12:18Z",
        "type": "string"
    }
  }
}

Error response
{
  "code": "117",
  "message": "No data found"
}

Workflows

Your StoneShot marketing automation workflows can be managed and queried.

Get workflows

More

Less

GET/workflows

Retrieve workflows associated with your account.

Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
workflow_idnamestatusdescriptioncreated_datemodified_datelast_start_date_utclast_end_date_utc
Other fields
list_id
count
The number of records to return. The default value is 100.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is workflow_id descending.
name
Restrict results based on the workflow name.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/workflows" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "workflows": [
    {
      "workflow_id": 0,
      "status": boolean,
      "name": "string",
      "description": "string",
      "created_date_utc": "2020-09-15T15:19:45Z",
      "modified_date_utc": "2020-09-29T11:47:56Z",
      "last_start_date_utc": "2020-09-29T11:47:56Z",
      "last_end_date_utc": "2020-09-29T11:47:56Z"
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Get workflow

More

Less

GET/workflows/{workflow_id}

Retrieve specific workflow associated with your account.

Path parameters
workflow_id
The unique StoneShot workflow id.
Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
workflow_idnamestatusdescriptioncreated_datemodified_datelast_start_date_utclast_end_date_utc
Other fields
list_id
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/workflows/[workflow_id]" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "workflow": {
    "workflow_id": 0,
    "status": boolean,
    "name": "string",
    "description": "string",
    "created_date_utc": "2020-09-15T15:19:45Z",
    "modified_date_utc": "2020-09-29T11:47:56Z",
    "last_start_date_utc": "2020-09-29T11:47:56Z",
    "last_end_date_utc": "2020-09-29T11:47:56Z"
  }
}

Error response
{
  "code": "117",
  "message": "No data found"
}

Get workflow contacts

More

Less

GET/workflows/{workflow_id}/contacts

Retrieve contacts associated to a specific workflow.

Path parameters
workflow_id
The unique StoneShot workflow id.
Query parameters
select
Include this query string for every field that you would like to return, for related objects use the dot notation. If omitted, then a default set of fields are returned.
Default fields
emailtitlefirst_namelast_namecompanycreate_date_utccontact_idlast_active_utc
Other fields
middle_namewebsitejob_titletelephonetelephone_extmobile_numberhome_numberaddress_1address_2address_3address_4citycountypostcodecountryopt_incustom_1prefer_htmlcreate_date_utcis_bouncesalesforce_account_idsalesforce_owner_iddouble_opt_in_statusunique_user_idsalesforce_idsiebel_iddynamics_id
count
The number of records to return. The default value is 1000.
offset
The number of records to be skipped. The default value is 0.
sort_by
The name of the field to sort by, include a ‘-‘ in front of the field name to sort by descending otherwise sorting will be ascending. The default sort field is contact_id descending.
contact_id
Restrict results based on a unique StoneShot contact id.
email
Restrict results based on contact email address.
title
Restrict results based on contact title.
first_name
Restrict results based on contact first name.
last_name
Restrict results based on contact last name.
company
Restrict results based on contact company.
job_title
Restrict results based on contact job title.
city
Restrict results based on contact city.
county
Restrict results based on contact county.
country
Restrict results based on contact country.
salesforce_id
Restrict results based on contact salesforce id.
siebel_id
Restrict results based on contact siebel id.
dynamics_id
Restrict results based on contact microsoft dynamics id.
unique_user_id
Restrict results based on contact unique external user id.
cURL example
curl -L -X GET \
  "https://api.stoneshot.com/v1/workflows/[workflow_id]/contacts" \ 
  -H "Authorization: Basic [PASSWORD]"

Success response
{
  "contacts": [
    {
      "contact_id": 0,
      "email": "string",
      "title": "string",
      "first_name": "string",
      "last_name": "string",
      "company": "string",
      "create_date_utc": "2019-06-13T15:00:45Z",
      "last_active_utc": "2020-08-06T15:03:10Z"
    }
  ]
}

Error response
{
  "code": "116",
  "message": "Invalid sort_by field. Please check your input"
}

Add contact to workflow

More

Less

PATCH/workflows/{workflow_id}/contacts/add

Add a contact to a specific workflow.

Path parameters
workflow_id
The unique StoneShot workflow id.
Body parameters
member_url_idstring
The contact member url (optional)
salesforce_idstring
The contact salesforce id (optional).
dynamics_idstring
The contact microsoft dynamics id (optional).
siebel_idstring
The contact siebel id (optional).
unique_user_idstring
The contact unique external user id (optional).
contact_idinteger
The unique StoneShot contact id (optional).
emailstring
The contact email address (optional).
cURL example
curl -L -X PATCH \
  "https://api.stoneshot.com/v1/workflows/[workflow_id]/contacts/add"
  -H "Authorization: Basic [PASSWORD]" \
  -d "{"email": "string}"

Success response
{
  "contacts": [
    {
      "contact_id": 0,
      "email": "string",
      "title": "string",
      "first_name": "string",
      "last_name": "string",
      "company": "string",
      "create_date_utc": "2017-07-27T17:34:51Z"
    }
  ]
}

Error response
{
  "code": "117",
  "message": "No data found"
}

Remove contact from workflow

More

Less

PATCH/workflows/{workflow_id}/contacts/remove

Remove a contact from a specific workflow.

Path parameters
workflow_id
The unique StoneShot workflow id.
Body parameters
member_url_idstring
The contact member url (optional)
salesforce_idstring
The contact salesforce id (optional).
dynamics_idstring
The contact microsoft dynamics id (optional).
siebel_idstring
The contact siebel id (optional).
unique_user_idstring
The contact unique external user id (optional).
contact_idinteger
The unique StoneShot contact id (optional).
emailstring
The contact email address (optional).
cURL example
curl -L -X PATCH \
  "https://api.stoneshot.com/v1/workflows/[workflow_id]/contacts/remove"
  -H "Authorization: Basic [PASSWORD]" \
  -d "{"email": "string}"

Success response
{
  "contacts": [
    {
      "contact_id": 0,
      "email": "string",
      "title": "string",
      "first_name": "string",
      "last_name": "string",
      "company": "string",
      "create_date_utc": "2017-07-27T17:34:51Z"
    }
  ]
}

Error response
{
  "code": "117",
  "message": "No data found"
}