TAtalon
Referrals

Update referral

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Update the specified referral.

put/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}

Request

Path parameters

applicationIdinteger required

The ID of the Application. It is displayed in your Talon.One deployment URL.

campaignIdinteger required

The ID of the campaign. It is displayed in your Talon.One deployment URL.

referralIdstring required

The ID of the referral code.

Request body

friendProfileIntegrationIdstring

An optional Integration ID of the Friend's Profile.

startDatestring date-time

Timestamp at which point the referral code becomes valid.

expiryDatestring date-time

Expiration date of the referral code. Referral never expires if this is omitted.

usageLimitinteger

The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply.

attributesobject

Arbitrary properties associated with this item.

Example request

{
  "friendProfileIntegrationId": "BZGGC2454PA",
  "startDate": "2020-11-10T23:00:00Z",
  "expiryDate": "2021-11-10T23:00:00Z",
  "usageLimit": 1
}

Response

OK

idinteger required

The internal ID of this entity.

createdstring date-time required

The time this entity was created.

startDatestring date-time

Timestamp at which point the referral code becomes valid.

expiryDatestring date-time

Expiration date of the referral code. Referral never expires if this is omitted.

usageLimitinteger required

The number of times a referral code can be used. 0 means no limit but any campaign usage limits will still apply.

campaignIdinteger required

ID of the campaign from which the referral received the referral code.

advocateProfileIntegrationIdstring required

The Integration ID of the Advocate's Profile.

friendProfileIntegrationIdstring

An optional Integration ID of the Friend's Profile.

attributesobject

Arbitrary properties associated with this item.

importIdinteger

The ID of the Import which created this referral.

codestring required

The referral code.

usageCounterinteger required

The number of times this referral code has been successfully used.

batchIdstring

The ID of the batch the referrals belong to.

Example response

{
  "id": 6,
  "created": "2020-06-10T09:05:27.993483Z",
  "startDate": "2020-11-10T23:00:00Z",
  "expiryDate": "2021-11-10T23:00:00Z",
  "usageLimit": 1,
  "campaignId": 78,
  "advocateProfileIntegrationId": "URNGV8294NV",
  "friendProfileIntegrationId": "BZGGC2454PA",
  "attributes": {
    "channel": "web"
  },
  "importId": 4,
  "code": "27G47Y54VH9L",
  "usageCounter": 1,
  "batchId": "tqyrgahe"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.