Get Campaign Reward Assignment

{ "id": "rewa_1gJ6VyYQI0IcnEvhArbr9XFH", "reward_id": "rew_injbwG52POgfpSogTlQl4hA6", "related_object_id": "camp_Vr97XXNOnFEUIMFymKK99FAA", "related_object_type": "campaign", "parameters": { "loyalty": { "points": 10 } }, "created_at": "2022-06-13T11:56:49.185Z", "updated_at": null, "object": "reward_assignment" }

{ "code": 404, "key": "not_found", "message": "Resource not found", "details": "Cannot find reward_assignment with id rewa_1gJ6VyYQI0IcnEvhArbr9XFH", "request_id": "v-0c0be6ee648e67609b", "resource_id": "rewa_1gJ6VyYQI0IcnEvhArbr9XFH", "resource_type": "reward_assignment" }

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Scopes

api

Gives access to whole server-side API.

loyalties

Gives access to all endpoints and methods starting with /v1/loyalties.

Path Parameters

campaignId

string

required

The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

assignmentId

string

required

A unique reward assignment ID.

Example:

"rewa_m9hEAu10KsPcLhGXiHG85aY0"

Response

Returns specific reward assignment.

Response body schema for GET v1/loyalties/{campaignId}/rewards/{assignmentId}

string

required

Unique reward assignment ID, assigned by Voucherify.

Example:

"rewa_PbIRoMXpwe5QhobW4JKu0VjH"

reward_id

string

required

Associated reward ID.

Example:

"rew_C7wS9eHFDN4CIbXI5PpLSkGY"

created_at

string<date-time>

required

Timestamp representing the date and time when the reward assignment was created. The value is shown in the ISO 8601 format.

Example:

"2022-08-11T14:49:22.586Z"

updated_at

string<date-time> | null

required

Timestamp representing the date and time when the reward assignment was updated. The value is shown in the ISO 8601 format.

Example:

"2022-08-11T16:01:34.885Z"

object

enum<string>

default:reward_assignment

required

The type of the object represented by the JSON. This object stores information about the reward assignment.

Available options:

reward_assignment

Related object ID to which the reward was assigned. For related_object_type campaign, this is the campaign ID. For referral_tier, this is the referral tier ID.

Example:

"camp_wciTvaOfYmAa3EmIIW3QpXXZ"

Related object type to which the reward was assigned. Use campaign for legacy loyalty campaign rewards. Use referral_tier for LOYALTY_POINTS rewards that credit a v2/loyalties (loyalty hub) card from a referral tier. A LOYALTY_POINTS reward can only be assigned to a referral tier.

Available options:

campaign,

referral_tier

parameters

object

Defines the cost of the reward.

Show child attributes

Introduction

Endpoints

Events

Get Campaign Reward Assignment

Authorizations

Scopes

Path Parameters

Response