Skip to main content
PATCH
/
accounts
/
api
/
account
Rename the account
curl --request PATCH \
  --url https://api.upstackdata.com/accounts/api/account \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-pixel-id: <api-key>' \
  --data '
{
  "accountName": "Upstack Data"
}
'
{
  "account": {
    "accountName": "Upstack Data",
    "createdAt": "2023-11-07T05:31:56Z",
    "owners": [
      {
        "email": "jsmith@example.com",
        "firstName": "<string>",
        "lastName": "<string>"
      }
    ],
    "admins": [
      {
        "email": "jsmith@example.com",
        "firstName": "<string>",
        "lastName": "<string>"
      }
    ],
    "subscription": {
      "plan": {
        "name": "Growth",
        "displayPrice": "$49/mo",
        "currency": "USD",
        "discountedDisplayPrice": "$39/mo",
        "discount": {
          "code": "LAUNCH20",
          "value": 123,
          "appliesUntil": "2023-11-07T05:31:56Z",
          "appliesForBillingIntervals": 123
        }
      },
      "status": "<string>",
      "trialEndsOn": "2023-11-07T05:31:56Z",
      "currentPeriodEnd": "2023-11-07T05:31:56Z",
      "cancelAtPeriodEnd": true
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.upstackdata.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

Your Upstack API key. Starts with upstack_.

x-pixel-id
string
header
required

The pixel id the request targets.

Body

application/json

Strict allowlist — accountName is the only accepted field. Any other key in the body is rejected with 400. Control / zero-width / bidi characters are rejected; unicode letters, marks, digits, punctuation, and emoji are accepted. Trimmed; leading/trailing whitespace rejected.

accountName
string
required
Required string length: 1 - 100
Example:

"Upstack Data"

Response

The renamed account projection.

account
object
required

Slim public projection of an account — display name, creation date, active owners and admins, optional subscription summary.

Internal fields are deliberately omitted: id, ownerId, companyName, primaryEmail, settings.*, pixels, subscriptionId, every Stripe ID, planUsage, usageBillingRecords, last12Months*, and similar implementation details.