younifyd
Menu

Export Referrals

Export referrals

GET/v1/applications/{applicationId}/export_referrals

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the Export Referrals action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{exportReferrals.response.data}}.

Request

Path parameters

applicationIdinteger (int64)required

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

Query parameters

campaignIdnumber

Filter results by campaign ID.

createdBeforestring (date-time)

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

createdAfterstring (date-time)

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

validstring

- `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future.

One ofexpiredvalidNowvalidFuture

usablestring

- `true`, only referrals where `usageCounter < usageLimit` will be returned. - `false`, only referrals where `usageCounter >= usageLimit` will be returned.

One oftruefalse

batchIdstring

Filter results by batches of referrals

dateFormatstring

Determines the format of dates in the export document.

One ofexcelISO8601

Response

Returns 200 with a string (csv). Read it in later steps with {{exportReferrals.response.data.<field>}}.

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Export Referrals — Talon.One — Documentation