Create Browser Profile
curl --request POST \
--url https://www.crossmint.com/api/unstable/agent-checkouts/browser-profiles \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"label": "Shopify Stores"
}
'import requests
url = "https://www.crossmint.com/api/unstable/agent-checkouts/browser-profiles"
payload = { "label": "Shopify Stores" }
headers = {
"X-API-KEY": "<api-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({label: 'Shopify Stores'})
};
fetch('https://www.crossmint.com/api/unstable/agent-checkouts/browser-profiles', 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://www.crossmint.com/api/unstable/agent-checkouts/browser-profiles",
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([
'label' => 'Shopify Stores'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://www.crossmint.com/api/unstable/agent-checkouts/browser-profiles"
payload := strings.NewReader("{\n \"label\": \"Shopify Stores\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://www.crossmint.com/api/unstable/agent-checkouts/browser-profiles")
.header("X-API-KEY", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"Shopify Stores\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.crossmint.com/api/unstable/agent-checkouts/browser-profiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"Shopify Stores\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"label": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}Browser Profiles
Create Browser Profile
Create a subject-scoped browser profile: a durable browser identity that lets a user’s merchant login be reused across checkout runs instead of signing in on every run.
A user has at most one browser profile, and it accumulates saved state across merchants.
API scope required: agent-checkouts.browser-profiles.create
POST
/
unstable
/
agent-checkouts
/
browser-profiles
Create Browser Profile
curl --request POST \
--url https://www.crossmint.com/api/unstable/agent-checkouts/browser-profiles \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"label": "Shopify Stores"
}
'import requests
url = "https://www.crossmint.com/api/unstable/agent-checkouts/browser-profiles"
payload = { "label": "Shopify Stores" }
headers = {
"X-API-KEY": "<api-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({label: 'Shopify Stores'})
};
fetch('https://www.crossmint.com/api/unstable/agent-checkouts/browser-profiles', 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://www.crossmint.com/api/unstable/agent-checkouts/browser-profiles",
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([
'label' => 'Shopify Stores'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://www.crossmint.com/api/unstable/agent-checkouts/browser-profiles"
payload := strings.NewReader("{\n \"label\": \"Shopify Stores\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://www.crossmint.com/api/unstable/agent-checkouts/browser-profiles")
.header("X-API-KEY", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"Shopify Stores\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.crossmint.com/api/unstable/agent-checkouts/browser-profiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"Shopify Stores\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"label": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}Authorizations
Client-side API key (ck_...) with the agent-checkouts.* scopes.
JWT identifying the end user, issued by an external auth provider your project trusts.
Body
application/json
Optional human-readable label for the profile.
Required string length:
1 - 120Response
The browser profile was created.
The browser profile, returned by create, get, list items, and update. Metadata only — no cookies, tokens, or local storage.
The browser profile id. Pass it as browserProfileId when creating a checkout.
When the label was last changed. Checkout runs do not update it.
Optional human-readable label for the profile.
Required string length:
1 - 120Was this page helpful?