VOvoucherifyio
Loyalties

Export Loyalty Campaign Point Expiration

Schedule the generation of a point expiration CSV file for a particular campaign. It can list point buckets, which can have an ACTIVE or EXPIRED status.

post/v1/loyalties/{campaignId}/points-expiration/export

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/loyalties/{campaignId}/points-expiration/export
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or OAuth 2
      Implicit: https://api.voucherify.io/v1/oauth/token
      Scopes: api, loyalties

Request body

Response

Returns an object with the export ID of the scheduled generation of CSV file with exported points expirations. You can use either the Download Export endpoint to download the CSV file.

idstring

Unique export ID.

object'export'

The type of object being represented. This object stores information about the export.

created_atstring date-time

Timestamp representing the date and time when the export was scheduled in ISO 8601 format.

status'SCHEDULED'

Status of the export. Informs you whether the export has already been completed.

channel'API' | 'WEBSITE'

The channel through which the export was triggered.

exported_object'points_expiration'

The type of exported object.

resultobject

Always null.

user_idstring

user_id identifies the specific user who initiated the export through the Voucherify Dashboard. user_id is returned when the channel value is WEBSITE.

Example response

{
  "id": "exp_FFfp9o7daWuJqJCKp5xqqli4",
  "created_at": "2022-04-28T11:23:20.922Z",
  "user_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0Fr"
}

Changes

No recorded changes to this operation across all 1 revision of this API.