Update an organization's subscription status entry for a user (mobile app access)
Patches the calling organization's subscription status entry for the user: only the fields present change, an omitted field is never reset, and a change equal to the current value is a no-op (event: null). An organization with no entry has mobile app access (mobileAppAccess: true). mobileAppAccess is an app entitlement, not door access, and nothing is enforced from it yet. An organization changes only its own entry (omit orgId, or name your own); a super API key may name any existing organization, and each super-key change is recorded in a permanent admin audit log first (503 with Retry-After when that record cannot be written). A user cannot change entries. Each change is delivered as a UserSubscriptionStatusUpdated webhook to the changed organization only, its own changes included; changedBy.kind says whether that organization or an administrator made it.
curl -X POST "https://api.spkey.co/users/example_string/UpdateSubscriptionStatus" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"mobileAppAccess": true,
"orgId": "example_string"
}'
import requests
import json
url = "https://api.spkey.co/users/example_string/UpdateSubscriptionStatus"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"mobileAppAccess": true,
"orgId": "example_string"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.spkey.co/users/example_string/UpdateSubscriptionStatus", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"mobileAppAccess": true,
"orgId": "example_string"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"mobileAppAccess": true,
"orgId": "example_string"
}`)
req, err := http.NewRequest("POST", "https://api.spkey.co/users/example_string/UpdateSubscriptionStatus", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.spkey.co/users/example_string/UpdateSubscriptionStatus')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
"mobileAppAccess": true,
"orgId": "example_string"
}'
response = http.request(request)
puts response.body
{
"success": true,
"aggregateId": "example_string",
"version": 3.14,
"event": "null"
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Service Unavailable",
"message": "The service is temporarily unavailable. Please try again later",
"code": 503
}
/users/{id}/UpdateSubscriptionStatusTarget server for requests. Edit to use your own host.
JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API key for B2B organization access. Provided during organization onboarding.
User ID
The media type of the request body
Whether the user may use the mobile app for this organization; an app entitlement, not door access
The organization whose entry to change; only a super API key may name another organization than its own
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Path Parameters
User ID
Body
Whether the user may use the mobile app for this organization; an app entitlement, not door access
The organization whose entry to change; only a super API key may name another organization than its own