Update a redemption entity

curl --request PATCH \
  --url https://api.voucher-staging.allride.io/consumer/v1/redemption-entities/{redemptionEntityId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "Fleet account 42",
  "metadata": {
    "segment": "b2b"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({displayName: 'Fleet account 42', metadata: {segment: 'b2b'}})
};

fetch('https://api.voucher-staging.allride.io/consumer/v1/redemption-entities/{redemptionEntityId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.voucher-staging.allride.io/consumer/v1/redemption-entities/{redemptionEntityId}"

payload = {
    "displayName": "Fleet account 42",
    "metadata": { "segment": "b2b" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

HttpResponse<String> response = Unirest.patch("https://api.voucher-staging.allride.io/consumer/v1/redemption-entities/{redemptionEntityId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"Fleet account 42\",\n  \"metadata\": {\n    \"segment\": \"b2b\"\n  }\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.voucher-staging.allride.io/consumer/v1/redemption-entities/{redemptionEntityId}"

	payload := strings.NewReader("{\n  \"displayName\": \"Fleet account 42\",\n  \"metadata\": {\n    \"segment\": \"b2b\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.voucher-staging.allride.io/consumer/v1/redemption-entities/{redemptionEntityId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'displayName' => 'Fleet account 42',
    'metadata' => [
        'segment' => 'b2b'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "id": 9017,
    "resource": "redemption-entity",
    "refId": "customer:48213",
    "displayName": "Fleet account 42",
    "email": null,
    "metadata": {
      "segment": "b2b"
    },
    "status": "active",
    "createdVia": "api",
    "erasedAt": null,
    "createdAt": "2026-10-22T08:20:00Z",
    "updatedAt": "2026-10-23T10:00:00Z",
    "_links": {
      "self": {
        "href": "https://api.voucher.allride.io/consumer/v1/redemption-entities/9017",
        "type": "application/json"
      }
    }
  }
}

PATCH

consumer

redemption-entities

{redemptionEntityId}

Update a redemption entity

curl --request PATCH \
  --url https://api.voucher-staging.allride.io/consumer/v1/redemption-entities/{redemptionEntityId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "Fleet account 42",
  "metadata": {
    "segment": "b2b"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({displayName: 'Fleet account 42', metadata: {segment: 'b2b'}})
};

fetch('https://api.voucher-staging.allride.io/consumer/v1/redemption-entities/{redemptionEntityId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.voucher-staging.allride.io/consumer/v1/redemption-entities/{redemptionEntityId}"

payload = {
    "displayName": "Fleet account 42",
    "metadata": { "segment": "b2b" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

HttpResponse<String> response = Unirest.patch("https://api.voucher-staging.allride.io/consumer/v1/redemption-entities/{redemptionEntityId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"Fleet account 42\",\n  \"metadata\": {\n    \"segment\": \"b2b\"\n  }\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.voucher-staging.allride.io/consumer/v1/redemption-entities/{redemptionEntityId}"

	payload := strings.NewReader("{\n  \"displayName\": \"Fleet account 42\",\n  \"metadata\": {\n    \"segment\": \"b2b\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.voucher-staging.allride.io/consumer/v1/redemption-entities/{redemptionEntityId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'displayName' => 'Fleet account 42',
    'metadata' => [
        'segment' => 'b2b'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "id": 9017,
    "resource": "redemption-entity",
    "refId": "customer:48213",
    "displayName": "Fleet account 42",
    "email": null,
    "metadata": {
      "segment": "b2b"
    },
    "status": "active",
    "createdVia": "api",
    "erasedAt": null,
    "createdAt": "2026-10-22T08:20:00Z",
    "updatedAt": "2026-10-23T10:00:00Z",
    "_links": {
      "self": {
        "href": "https://api.voucher.allride.io/consumer/v1/redemption-entities/9017",
        "type": "application/json"
      }
    }
  }
}

Authorizations

Authorization

string

header

required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Path Parameters

redemptionEntityId

integer<uint64>

required

Id of the redemption entity. Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Body

application/json

JSON Merge Patch. email, status and createdVia are not writable.

refId

string | null

New refId; null clears.

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9._:@/+=-]{1,128}$

displayName

string | null

1-120 characters; null clears.

Maximum string length: 120

metadata

object | null

Replaced as a whole; null clears.

Example:

{ "orderId": "8812", "channel": "app" }

Response

Single-object envelope around a RedemptionEntity.

data

object

required

Your record of who or what redeems. An erased entity returns refId, displayName, email and metadata as null.

Show child attributes

Consumer API

Workspace API

Update a redemption entity

Authorizations

Path Parameters

Body

Response