Store/Update Conversion (Inbound Call)

This API request stores inbound call conversion data, for a specific site using the HTTP method PUT. The request includes the following parameters:

Headers:

AuthorizationstringRequired

The authorization token for accessing the API. The header value should be set to "Bearer {your-access-token}", where {your-access-token} is the access token assigned to the user.

Request Body(JSON payload):

The data containing the conversion information to store/update. The payload should include the following parameters:

StartDateTimeISOstringRequired

The date and time the call started in ISO 8601 format (yyyy-MM-ddThh:mm:ss) and in UTC time standard.

EndDateTimeISOstringRequired

The date and time the call ended in ISO 8601 format (yyyy-MM-ddThh:mm:ss) and in UTC time standard.

CalledNumberstringRequired

The number which was called.

CallerNumberstringRequired

The number of the person who made the call.

ReferencestringRequired

The reference of the call. This should be a unique value.

VisitorIdentifierOptionsArray

An array of visitor identifiers. Each item in the array should include the following parameters:

KeystringRequired

The key for the visitor identifier. Accepted Keys: EmailAddress, RaId, CookieValue

Please note that when using CookieValue there should be no other visitor identifiers present. EmailAddress and RaId will take precedence over CookieValue.

ValuestringRequired

The value for the visitor identifier.

If using the CookieValue identifier you must pass the Google Client ID without the GA.1.1 prefix. e.g. GA1.1.101961087.1756204614 should be sent as 101961087.1756204614

RefererLabelstring

The referer label for the call.

AnswerTimestring

The amount of time it took for called number to answer.

Resultstring

The result of the call. E.g. Answered.

MarketingChannelOverridestring

The Marketing Channel Override you would like to provide: See table below for reference values.

SourceCategoryOverridestring

The Source Category Override you would like to provide: See table below for reference values.


SourceMarketing Channels
UnMatchedNotApplicable
DirectNotApplicable
OfflineNotApplicable
ReferralNotApplicable
EmailNotApplicable
SMSNotApplicable
GooglePaid, Organic, Places
YahooPaid, Organic
BingPaid, Organic
FacebookPaid, Organic
TwitterPaid, Organic
LinkedInPaid, Organic
PinterestPaid, Organic
InstagramPaid, Organic
YouTubePaid, Organic
TikTokPaid, Organic
RedditPaid, Organic
SnapchatPaid, Organic
AdRollPaid, Organic
DuckDuckGoPaid, Organic
OutbrainPaid
StackAdaptPaid
AwinPaid
KlaviyoPaid
CriteoPaid
ImpactPaid
ShareASalePaid
TaboolaPaid
TheTradeDeskPaid
JourneyNotApplicable
Note that this source will join the call onto an existing touchpoint if one is found to match.
Other sources will create a new touchpoint.
Custom SourceCustom
Use this method when you want to upload to one of your custom sources. Replace Custom Source with the name of your source
ChatGPTOrganic


The {your-access-token} parameter in the authorization header should be replaced with the appropriate access token.

Request
PUT
{siteId}/conversion/inboundcall/upload
curl -X PUT \
  'https://rest.rulerapi.com/v1/{siteId}/conversion/inboundcall/upload' \
  -H 'Authorization: Bearer {your-access-token}' \
  -H 'Content-Type: application/json' \
  -d {
    "StartDateTimeISO": "{startDateTimeISO}",
    "EndDateTimeISO": "{endDateTimeISO}",
    "CalledNumber": "{calledNumber}",
    "CallerNumber": "{callerNumber}",
    "Reference": "{reference}",
    "VisitorIdentifierOptions": [{
        "key": "{key}",
        "value": "{value}"
    }],
    "RefererLabel": "{refererLabel}",
    "AnswerTime": "{answerTime}",
    "Result": "{result}",
    "MarketingChannelOverride" : "{marketingChannelOverride}",
    "SourceCategoryOverride": "{sourceCategoryOverride}"
}
Response
Status: 202
API Thresholds
maxRequestsPerSecond: 1000 maxConcurrentRequests: 1000