Store/Update Conversion (Web)

This API request stores web conversion data such as a form, 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:

CaptureDateTimestringRequired

The date and time the conversion was captured. Must be in ISO 8601 format. yyyy-MM-dd

VisitorIdentifierOptionsArrayRequired

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, PhoneNumber, RaId, CookieValue

ValuestringRequired

The value for the visitor identifier.

PayloadArrayRequired

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

KeystringRequired

The key for the payload item.

ValuestringRequired

The value for the payload item.

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.

Source	Marketing Channels
UnMatched	NotApplicable
Direct	NotApplicable
Offline	NotApplicable
Referral	NotApplicable
Email	NotApplicable
Google	Paid, Organic, Places
Yahoo	Paid, Organic
Bing	Paid, Organic
Facebook	Paid, Organic
Twitter	Paid, Organic
LinkedIn	Paid, Organic
Pinterest	Paid, Organic
Instagram	Paid, Organic
YouTube	Paid, Organic
TikTok	Paid, Organic
Reddit	Paid, Organic
Snapchat	Paid, Organic
AdRoll	Paid, Organic
DuckDuckGo	Paid, Organic
Outbrain	Paid
StackAdapt	Paid
Awin	Paid
Journey	NotApplicable	Note that this source will join the form onto an existing touchpoint if one is found to match. Other sources will create a new touchpoint.

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

Request

PUT

{siteId}/conversion/web/upload

curl -X PUT \
  'https://rest.rulerapi.com/v1/{siteId}/conversion/web/upload' \
  -H 'Authorization: Bearer {your-access-token}' \
  -H 'Content-Type: application/json' \
  -d {
    "CaptureDateTime": "{captureDateTime}",
    "VisitorIdentifierOptions": [{
        "Key": "{key}",
        "Value": "{value}"
    }],
    "Payload": [{
        "key": "{key}",
        "value": "{value}"
    }],
    "MarketingChannelOverride" : "{marketingChannelOverride}",
    "SourceCategoryOverride": "{sourceCategoryOverride}"
}

Response

Status: 202