Create a provider profile change request
curl --request POST \
--url https://api.voucher-staging.allride.io/provider/v1/provider-profile/change-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"proposedContent": {
"displayName": {
"de": "Acme Scooters",
"en": "Acme Scooters"
},
"tagline": {
"de": "E-Scooter in deiner Stadt",
"en": "E-scooters in your city"
},
"description": {
"de": "Fahre **emissionsfrei** durch die Stadt.",
"en": "Ride **emission-free** through the city."
},
"termsText": null,
"termsUrl": "https://acme-scooters.example.com/terms",
"privacyUrl": "https://acme-scooters.example.com/privacy",
"websiteUrl": "https://acme-scooters.example.com",
"supportUrl": "https://acme-scooters.example.com/help",
"appLinks": {
"appStoreUrl": "https://apps.apple.com/app/id000000001",
"playStoreUrl": "https://play.google.com/store/apps/details?id=com.example.acmescooters"
},
"defaultCategoryId": 7017,
"countries": [
"DE",
"AT"
]
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
proposedContent: {
displayName: {de: 'Acme Scooters', en: 'Acme Scooters'},
tagline: {de: 'E-Scooter in deiner Stadt', en: 'E-scooters in your city'},
description: {
de: 'Fahre **emissionsfrei** durch die Stadt.',
en: 'Ride **emission-free** through the city.'
},
termsText: null,
termsUrl: 'https://acme-scooters.example.com/terms',
privacyUrl: 'https://acme-scooters.example.com/privacy',
websiteUrl: 'https://acme-scooters.example.com',
supportUrl: 'https://acme-scooters.example.com/help',
appLinks: {
appStoreUrl: 'https://apps.apple.com/app/id000000001',
playStoreUrl: 'https://play.google.com/store/apps/details?id=com.example.acmescooters'
},
defaultCategoryId: 7017,
countries: ['DE', 'AT']
}
})
};
fetch('https://api.voucher-staging.allride.io/provider/v1/provider-profile/change-requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/provider/v1/provider-profile/change-requests"
payload = { "proposedContent": {
"displayName": {
"de": "Acme Scooters",
"en": "Acme Scooters"
},
"tagline": {
"de": "E-Scooter in deiner Stadt",
"en": "E-scooters in your city"
},
"description": {
"de": "Fahre **emissionsfrei** durch die Stadt.",
"en": "Ride **emission-free** through the city."
},
"termsText": None,
"termsUrl": "https://acme-scooters.example.com/terms",
"privacyUrl": "https://acme-scooters.example.com/privacy",
"websiteUrl": "https://acme-scooters.example.com",
"supportUrl": "https://acme-scooters.example.com/help",
"appLinks": {
"appStoreUrl": "https://apps.apple.com/app/id000000001",
"playStoreUrl": "https://play.google.com/store/apps/details?id=com.example.acmescooters"
},
"defaultCategoryId": 7017,
"countries": ["DE", "AT"]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/provider/v1/provider-profile/change-requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"proposedContent\": {\n \"displayName\": {\n \"de\": \"Acme Scooters\",\n \"en\": \"Acme Scooters\"\n },\n \"tagline\": {\n \"de\": \"E-Scooter in deiner Stadt\",\n \"en\": \"E-scooters in your city\"\n },\n \"description\": {\n \"de\": \"Fahre **emissionsfrei** durch die Stadt.\",\n \"en\": \"Ride **emission-free** through the city.\"\n },\n \"termsText\": null,\n \"termsUrl\": \"https://acme-scooters.example.com/terms\",\n \"privacyUrl\": \"https://acme-scooters.example.com/privacy\",\n \"websiteUrl\": \"https://acme-scooters.example.com\",\n \"supportUrl\": \"https://acme-scooters.example.com/help\",\n \"appLinks\": {\n \"appStoreUrl\": \"https://apps.apple.com/app/id000000001\",\n \"playStoreUrl\": \"https://play.google.com/store/apps/details?id=com.example.acmescooters\"\n },\n \"defaultCategoryId\": 7017,\n \"countries\": [\n \"DE\",\n \"AT\"\n ]\n }\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/provider/v1/provider-profile/change-requests"
payload := strings.NewReader("{\n \"proposedContent\": {\n \"displayName\": {\n \"de\": \"Acme Scooters\",\n \"en\": \"Acme Scooters\"\n },\n \"tagline\": {\n \"de\": \"E-Scooter in deiner Stadt\",\n \"en\": \"E-scooters in your city\"\n },\n \"description\": {\n \"de\": \"Fahre **emissionsfrei** durch die Stadt.\",\n \"en\": \"Ride **emission-free** through the city.\"\n },\n \"termsText\": null,\n \"termsUrl\": \"https://acme-scooters.example.com/terms\",\n \"privacyUrl\": \"https://acme-scooters.example.com/privacy\",\n \"websiteUrl\": \"https://acme-scooters.example.com\",\n \"supportUrl\": \"https://acme-scooters.example.com/help\",\n \"appLinks\": {\n \"appStoreUrl\": \"https://apps.apple.com/app/id000000001\",\n \"playStoreUrl\": \"https://play.google.com/store/apps/details?id=com.example.acmescooters\"\n },\n \"defaultCategoryId\": 7017,\n \"countries\": [\n \"DE\",\n \"AT\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", 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/provider/v1/provider-profile/change-requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'proposedContent' => [
'displayName' => [
'de' => 'Acme Scooters',
'en' => 'Acme Scooters'
],
'tagline' => [
'de' => 'E-Scooter in deiner Stadt',
'en' => 'E-scooters in your city'
],
'description' => [
'de' => 'Fahre **emissionsfrei** durch die Stadt.',
'en' => 'Ride **emission-free** through the city.'
],
'termsText' => null,
'termsUrl' => 'https://acme-scooters.example.com/terms',
'privacyUrl' => 'https://acme-scooters.example.com/privacy',
'websiteUrl' => 'https://acme-scooters.example.com',
'supportUrl' => 'https://acme-scooters.example.com/help',
'appLinks' => [
'appStoreUrl' => 'https://apps.apple.com/app/id000000001',
'playStoreUrl' => 'https://play.google.com/store/apps/details?id=com.example.acmescooters'
],
'defaultCategoryId' => 7017,
'countries' => [
'DE',
'AT'
]
]
]),
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": 10030,
"resource": "change-request",
"partnerId": 42,
"subjectType": "voucher-set",
"subjectId": 2030,
"kind": "update",
"origin": "provider",
"status": "approved",
"baseRevisionNo": 1,
"proposedContent": {
"name": {
"de": "5 € Fahrguthaben",
"en": "€5 ride credit"
},
"summary": {
"de": "Für alle E-Scooter",
"en": "For all e-scooters"
},
"bullets": [
{
"de": "Einmal einlösbar",
"en": "Single use"
}
],
"description": null,
"howToRedeem": [
{
"de": "App öffnen und Code unter Wallet eingeben",
"en": "Open the app and enter the code under Wallet"
}
],
"termsText": {
"de": "Einmal pro Konto einlösbar.",
"en": "Redeemable once per account."
},
"valueLabel": {
"de": "5 € Rabatt",
"en": "€5 off"
},
"faceValue": {
"value": 500,
"label": "5,00 €"
},
"categoryId": 7017,
"linkTemplate": "https://acme-scooters.example.com/r?c={{code}}",
"allowedLinkHosts": [
"acme-scooters.example.com"
],
"allowedLinkSchemes": [],
"brandingOverride": null,
"countries": [
"DE"
],
"extensions": null,
"metadata": null
},
"diff": [
{
"path": "/faceValue/value",
"before": 300,
"after": 500
},
{
"path": "/linkTemplate",
"before": null,
"after": "https://acme-scooters.example.com/r?c={{code}}"
}
],
"changedFields": [
"faceValue",
"linkTemplate"
],
"warnings": [],
"providerNote": "Raise the value to €5 and add the deep link.",
"approvedContent": null,
"modifiedByAdmin": false,
"modificationDiff": null,
"appliedRevisionNo": 2,
"isStale": false,
"decisionReason": null,
"submittedBy": {
"type": "partner-user",
"id": 4043,
"label": "ops@example.com"
},
"reviewedBy": {
"type": "admin-user",
"id": null,
"label": "AllRide"
},
"submittedAt": "2026-10-21T10:02:00Z",
"reviewedAt": "2026-10-21T16:20:00Z",
"createdAt": "2026-10-21T09:58:41.002Z",
"updatedAt": "2026-10-21T16:20:00Z",
"_links": {
"self": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/change-requests/10030",
"type": "application/json"
},
"subject": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030",
"type": "application/json"
},
"appliedRevision": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/revisions/22017",
"type": "application/json"
}
}
}
}Change requests
Create a provider profile change request
Proposes new content for the provider profile. With submit: true (the default) the complete content is validated, automated checks run and the change request goes to scanning. With submit: false a draft is created. Only one change request per subject can be open. AllRide reviews every change request; you are told through the change-request-approved or change-request-rejected webhook. See Change requests and approval.
Required permissions: manage-provider-profile · API keys: allowed
POST
/
provider
/
v1
/
provider-profile
/
change-requests
Create a provider profile change request
curl --request POST \
--url https://api.voucher-staging.allride.io/provider/v1/provider-profile/change-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"proposedContent": {
"displayName": {
"de": "Acme Scooters",
"en": "Acme Scooters"
},
"tagline": {
"de": "E-Scooter in deiner Stadt",
"en": "E-scooters in your city"
},
"description": {
"de": "Fahre **emissionsfrei** durch die Stadt.",
"en": "Ride **emission-free** through the city."
},
"termsText": null,
"termsUrl": "https://acme-scooters.example.com/terms",
"privacyUrl": "https://acme-scooters.example.com/privacy",
"websiteUrl": "https://acme-scooters.example.com",
"supportUrl": "https://acme-scooters.example.com/help",
"appLinks": {
"appStoreUrl": "https://apps.apple.com/app/id000000001",
"playStoreUrl": "https://play.google.com/store/apps/details?id=com.example.acmescooters"
},
"defaultCategoryId": 7017,
"countries": [
"DE",
"AT"
]
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
proposedContent: {
displayName: {de: 'Acme Scooters', en: 'Acme Scooters'},
tagline: {de: 'E-Scooter in deiner Stadt', en: 'E-scooters in your city'},
description: {
de: 'Fahre **emissionsfrei** durch die Stadt.',
en: 'Ride **emission-free** through the city.'
},
termsText: null,
termsUrl: 'https://acme-scooters.example.com/terms',
privacyUrl: 'https://acme-scooters.example.com/privacy',
websiteUrl: 'https://acme-scooters.example.com',
supportUrl: 'https://acme-scooters.example.com/help',
appLinks: {
appStoreUrl: 'https://apps.apple.com/app/id000000001',
playStoreUrl: 'https://play.google.com/store/apps/details?id=com.example.acmescooters'
},
defaultCategoryId: 7017,
countries: ['DE', 'AT']
}
})
};
fetch('https://api.voucher-staging.allride.io/provider/v1/provider-profile/change-requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/provider/v1/provider-profile/change-requests"
payload = { "proposedContent": {
"displayName": {
"de": "Acme Scooters",
"en": "Acme Scooters"
},
"tagline": {
"de": "E-Scooter in deiner Stadt",
"en": "E-scooters in your city"
},
"description": {
"de": "Fahre **emissionsfrei** durch die Stadt.",
"en": "Ride **emission-free** through the city."
},
"termsText": None,
"termsUrl": "https://acme-scooters.example.com/terms",
"privacyUrl": "https://acme-scooters.example.com/privacy",
"websiteUrl": "https://acme-scooters.example.com",
"supportUrl": "https://acme-scooters.example.com/help",
"appLinks": {
"appStoreUrl": "https://apps.apple.com/app/id000000001",
"playStoreUrl": "https://play.google.com/store/apps/details?id=com.example.acmescooters"
},
"defaultCategoryId": 7017,
"countries": ["DE", "AT"]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/provider/v1/provider-profile/change-requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"proposedContent\": {\n \"displayName\": {\n \"de\": \"Acme Scooters\",\n \"en\": \"Acme Scooters\"\n },\n \"tagline\": {\n \"de\": \"E-Scooter in deiner Stadt\",\n \"en\": \"E-scooters in your city\"\n },\n \"description\": {\n \"de\": \"Fahre **emissionsfrei** durch die Stadt.\",\n \"en\": \"Ride **emission-free** through the city.\"\n },\n \"termsText\": null,\n \"termsUrl\": \"https://acme-scooters.example.com/terms\",\n \"privacyUrl\": \"https://acme-scooters.example.com/privacy\",\n \"websiteUrl\": \"https://acme-scooters.example.com\",\n \"supportUrl\": \"https://acme-scooters.example.com/help\",\n \"appLinks\": {\n \"appStoreUrl\": \"https://apps.apple.com/app/id000000001\",\n \"playStoreUrl\": \"https://play.google.com/store/apps/details?id=com.example.acmescooters\"\n },\n \"defaultCategoryId\": 7017,\n \"countries\": [\n \"DE\",\n \"AT\"\n ]\n }\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/provider/v1/provider-profile/change-requests"
payload := strings.NewReader("{\n \"proposedContent\": {\n \"displayName\": {\n \"de\": \"Acme Scooters\",\n \"en\": \"Acme Scooters\"\n },\n \"tagline\": {\n \"de\": \"E-Scooter in deiner Stadt\",\n \"en\": \"E-scooters in your city\"\n },\n \"description\": {\n \"de\": \"Fahre **emissionsfrei** durch die Stadt.\",\n \"en\": \"Ride **emission-free** through the city.\"\n },\n \"termsText\": null,\n \"termsUrl\": \"https://acme-scooters.example.com/terms\",\n \"privacyUrl\": \"https://acme-scooters.example.com/privacy\",\n \"websiteUrl\": \"https://acme-scooters.example.com\",\n \"supportUrl\": \"https://acme-scooters.example.com/help\",\n \"appLinks\": {\n \"appStoreUrl\": \"https://apps.apple.com/app/id000000001\",\n \"playStoreUrl\": \"https://play.google.com/store/apps/details?id=com.example.acmescooters\"\n },\n \"defaultCategoryId\": 7017,\n \"countries\": [\n \"DE\",\n \"AT\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", 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/provider/v1/provider-profile/change-requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'proposedContent' => [
'displayName' => [
'de' => 'Acme Scooters',
'en' => 'Acme Scooters'
],
'tagline' => [
'de' => 'E-Scooter in deiner Stadt',
'en' => 'E-scooters in your city'
],
'description' => [
'de' => 'Fahre **emissionsfrei** durch die Stadt.',
'en' => 'Ride **emission-free** through the city.'
],
'termsText' => null,
'termsUrl' => 'https://acme-scooters.example.com/terms',
'privacyUrl' => 'https://acme-scooters.example.com/privacy',
'websiteUrl' => 'https://acme-scooters.example.com',
'supportUrl' => 'https://acme-scooters.example.com/help',
'appLinks' => [
'appStoreUrl' => 'https://apps.apple.com/app/id000000001',
'playStoreUrl' => 'https://play.google.com/store/apps/details?id=com.example.acmescooters'
],
'defaultCategoryId' => 7017,
'countries' => [
'DE',
'AT'
]
]
]),
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": 10030,
"resource": "change-request",
"partnerId": 42,
"subjectType": "voucher-set",
"subjectId": 2030,
"kind": "update",
"origin": "provider",
"status": "approved",
"baseRevisionNo": 1,
"proposedContent": {
"name": {
"de": "5 € Fahrguthaben",
"en": "€5 ride credit"
},
"summary": {
"de": "Für alle E-Scooter",
"en": "For all e-scooters"
},
"bullets": [
{
"de": "Einmal einlösbar",
"en": "Single use"
}
],
"description": null,
"howToRedeem": [
{
"de": "App öffnen und Code unter Wallet eingeben",
"en": "Open the app and enter the code under Wallet"
}
],
"termsText": {
"de": "Einmal pro Konto einlösbar.",
"en": "Redeemable once per account."
},
"valueLabel": {
"de": "5 € Rabatt",
"en": "€5 off"
},
"faceValue": {
"value": 500,
"label": "5,00 €"
},
"categoryId": 7017,
"linkTemplate": "https://acme-scooters.example.com/r?c={{code}}",
"allowedLinkHosts": [
"acme-scooters.example.com"
],
"allowedLinkSchemes": [],
"brandingOverride": null,
"countries": [
"DE"
],
"extensions": null,
"metadata": null
},
"diff": [
{
"path": "/faceValue/value",
"before": 300,
"after": 500
},
{
"path": "/linkTemplate",
"before": null,
"after": "https://acme-scooters.example.com/r?c={{code}}"
}
],
"changedFields": [
"faceValue",
"linkTemplate"
],
"warnings": [],
"providerNote": "Raise the value to €5 and add the deep link.",
"approvedContent": null,
"modifiedByAdmin": false,
"modificationDiff": null,
"appliedRevisionNo": 2,
"isStale": false,
"decisionReason": null,
"submittedBy": {
"type": "partner-user",
"id": 4043,
"label": "ops@example.com"
},
"reviewedBy": {
"type": "admin-user",
"id": null,
"label": "AllRide"
},
"submittedAt": "2026-10-21T10:02:00Z",
"reviewedAt": "2026-10-21T16:20:00Z",
"createdAt": "2026-10-21T09:58:41.002Z",
"updatedAt": "2026-10-21T16:20:00Z",
"_links": {
"self": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/change-requests/10030",
"type": "application/json"
},
"subject": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030",
"type": "application/json"
},
"appliedRevision": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/revisions/22017",
"type": "application/json"
}
}
}
}Authorizations
Partner API key: Authorization: Bearer vk_live_…. Use vk_test_… keys against the sandbox. See Authentication.
Headers
Optional on every POST: 1-255 printable ASCII characters without spaces (a UUID is recommended). The same key with the same request replays the stored response for 24 hours. See Idempotency.
Required string length:
1 - 255Pattern:
^[\x21-\x7E]{1,255}$Body
application/json
Response
Success.
Single-object envelope around ChangeRequest.
A proposed change of consumer-visible content that AllRide reviews.
Show child attributes
Show child attributes