Create an idempotent promotional credit claim
curl --request POST \
--url https://sparkles.dev/api/public/v1/credit-claims \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"leadId": "<string>",
"email": "jsmith@example.com",
"variant": "<string>",
"creditAmount": 500000
}
'import requests
url = "https://sparkles.dev/api/public/v1/credit-claims"
payload = {
"leadId": "<string>",
"email": "jsmith@example.com",
"variant": "<string>",
"creditAmount": 500000
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
leadId: '<string>',
email: 'jsmith@example.com',
variant: '<string>',
creditAmount: 500000
})
};
fetch('https://sparkles.dev/api/public/v1/credit-claims', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sparkles.dev/api/public/v1/credit-claims",
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([
'leadId' => '<string>',
'email' => 'jsmith@example.com',
'variant' => '<string>',
'creditAmount' => 500000
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sparkles.dev/api/public/v1/credit-claims"
payload := strings.NewReader("{\n \"leadId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"variant\": \"<string>\",\n \"creditAmount\": 500000\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))
}HttpResponse<String> response = Unirest.post("https://sparkles.dev/api/public/v1/credit-claims")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"leadId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"variant\": \"<string>\",\n \"creditAmount\": 500000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sparkles.dev/api/public/v1/credit-claims")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"leadId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"variant\": \"<string>\",\n \"creditAmount\": 500000\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"leadId": "<string>",
"variant": "<string>",
"creditAmount": 123,
"claimUrl": "<string>",
"statusUrl": "<string>",
"createdAt": "<string>",
"claimedAt": "<string>"
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"leadId": "<string>",
"variant": "<string>",
"creditAmount": 123,
"claimUrl": "<string>",
"statusUrl": "<string>",
"createdAt": "<string>",
"claimedAt": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}partner credits
Create an idempotent promotional credit claim
The leadId is the idempotency key within the API access grant. An exact retry returns the existing claim; a retry with changed claim details returns 409.
POST
/
api
/
public
/
v1
/
credit-claims
Create an idempotent promotional credit claim
curl --request POST \
--url https://sparkles.dev/api/public/v1/credit-claims \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"leadId": "<string>",
"email": "jsmith@example.com",
"variant": "<string>",
"creditAmount": 500000
}
'import requests
url = "https://sparkles.dev/api/public/v1/credit-claims"
payload = {
"leadId": "<string>",
"email": "jsmith@example.com",
"variant": "<string>",
"creditAmount": 500000
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
leadId: '<string>',
email: 'jsmith@example.com',
variant: '<string>',
creditAmount: 500000
})
};
fetch('https://sparkles.dev/api/public/v1/credit-claims', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sparkles.dev/api/public/v1/credit-claims",
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([
'leadId' => '<string>',
'email' => 'jsmith@example.com',
'variant' => '<string>',
'creditAmount' => 500000
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sparkles.dev/api/public/v1/credit-claims"
payload := strings.NewReader("{\n \"leadId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"variant\": \"<string>\",\n \"creditAmount\": 500000\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))
}HttpResponse<String> response = Unirest.post("https://sparkles.dev/api/public/v1/credit-claims")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"leadId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"variant\": \"<string>\",\n \"creditAmount\": 500000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sparkles.dev/api/public/v1/credit-claims")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"leadId\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"variant\": \"<string>\",\n \"creditAmount\": 500000\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"leadId": "<string>",
"variant": "<string>",
"creditAmount": 123,
"claimUrl": "<string>",
"statusUrl": "<string>",
"createdAt": "<string>",
"claimedAt": "<string>"
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"leadId": "<string>",
"variant": "<string>",
"creditAmount": 123,
"claimUrl": "<string>",
"statusUrl": "<string>",
"createdAt": "<string>",
"claimedAt": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Long-lived opaque API key minted by an approved user at /api. The secret is shown once, stored only as a SHA-256 digest, and disabled immediately when either the key or its API access grant is revoked.
Body
application/json
Required string length:
1 - 200Maximum string length:
320Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Required string length:
1 - 100Required range:
1 <= x <= 1000000Response
An identical claim already existed
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Required range:
x <= 9007199254740991Available options:
pending, claimed, cancelled ⌘I