Add and Redeem Benefit Claim

A POST to the /profiles/{profileId}/benefits/claim-redeem endpoint allows your application to create and immediatly claim a Benefit Redemption.

This method is similar to Add Benefit Claim, but in addition to claiming, the benefit is also immediately redeemed against the claiming profile.
This is useful in situations where the benefit must be immediately consumed after a claim

{
    "data": {
        "id": 16,
        "profile_id": "92d7fbd9-1eda-47b5-3312-7b3227ca3b9e",
        "external_id": null,
        "expires_at": "2021-04-24 23:59:59",
        "issued_at": "2021-03-05 00:06:51",
        "is_expired": false,
        "is_redeemable": true,
        "redemptions_remaining": 1,
        "total_global_redemptions_remaining": 1,
        "definition": {
            "id": "3",
            "name": "10%OFFDEMO",
            "handle": "10offdemo",
            "period": 50,
            "description": "10% off",
            "internal_notes": "demo",
            "short_description": "A quick 10% off",
            "long_description": "Just another 10% voucher for you",
            "terms_conditions": "standard terms and conditions apply",
            "earn_instructions": null,
            "redeem_instructions_store": null,
            "redeem_instructions_online": null,
            "redeem_code_pos": "10OFFSTORE",
            "redeem_code_online": "10OFFONLINE",
            "icon": null,
            "image_url": "https://example.com/image.jpeg",
            "max_redemptions": 1,
            "is_extendable": false,
            "is_assignable": true,
            "is_reassignable": false,
            "is_published": true,
            "is_archived": false,
            "tags": [
                "demo"
            ],
            "is_claimable": true,
            "max_global_redemptions": null,
            "claim_period_start_at": "2020-12-25 07:00:00",
            "claim_period_end_at": "2021-05-08 23:00:00",
            "claim_condition": {
                "and": [
                    {
                        "===": [
                            "female",
                            {
                                "var": "gender"
                            }
                        ]
                    }
                ]
            },
            "is_reclaimable": true,
            "notify_schedule_offset": null,
            "notify_issue_offset_days": null,
            "notify_issue_offset_hour": null,
            "notify_remind_offset_days": null,
            "notify_remind_offset_hour": null,
            "notify_extend_offset_days": null,
            "notify_extend_offset_hour": null,
            "remind_target_id": null,
            "extend_target_id": null,
            "issue_target_id": null,
            "end_at": null,
            "total_allocations": null,
            "total_allocations_remaining": null,
            "force_allocation": false,
            "created_at": "2021-03-04 03:30:54",
            "updated_at": "2021-03-04 03:47:47"
        },
        "timezone": "Australia/Melbourne",
        "claimed_at": "2021-03-05 00:06:51",
        "meta": null,
        "redeem_code_pos": "10OFFSTORE",
        "redeem_code_online": "10OFFONLINE",
        "created_at": "2021-03-05 00:06:51",
        "updated_at": "2021-03-05 00:06:51"
    }
}
AttributeDescription
definition
STRING
The definition handle of the benefit definition you wish to claim
timezone
TIMEZONE
A valid timezone
Where the definition was claimed
external_id
STRING
The external ID of the benefit claim. Usually a reference to the claim in the external client system
meta
ARRAY
An array of metadata attached to the claim
Language
Credentials
Header
URL