Skip to main content
PATCH
/
v1
/
my
/
account
Update account settings
curl --request PATCH \
  --url https://api.nitrosend.com/v1/my/account \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "avatar": "<string>",
  "banner": "<string>",
  "email_from_name": "<string>",
  "email_from_email": "jsmith@example.com",
  "email_reply_to": "jsmith@example.com",
  "test_email_recipients": [
    "jsmith@example.com"
  ]
}
'
{
  "id": 123,
  "name": "<string>",
  "avatar": "<string>",
  "banner": "<string>",
  "comped": true,
  "onboarding_state": {},
  "onboarding": {
    "steps": {},
    "progress": {
      "completed": 123,
      "total": 123
    }
  },
  "domain_verified": true,
  "can_send": true,
  "using_sandbox": true,
  "sandbox_email": "<string>",
  "sandbox_monthly_cap": 123,
  "sandbox_sends_remaining": 123,
  "capabilities": {},
  "spend_cap_monthly_cents": 123,
  "billing": {
    "plan_name": "<string>",
    "wallet_balance_cents": 123,
    "auto_topup": true,
    "resources": {
      "email": {
        "used": 123,
        "allowance": 123,
        "remaining": 123,
        "overage_rate": 123
      },
      "sms": {
        "used": 123,
        "allowance": 123,
        "remaining": 123,
        "overage_rate": 123
      },
      "ai": {
        "used": 123,
        "allowance": 123,
        "remaining": 123,
        "overage_rate": 123
      }
    },
    "lifetime": {
      "email_sent": 123,
      "sms_sent": 123,
      "ai_used": 123
    }
  },
  "email_from_name": "<string>",
  "email_from_email": "<string>",
  "email_reply_to": "<string>",
  "test_email_recipients": [
    "jsmith@example.com"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "brand": {
    "id": 123,
    "account_id": 123,
    "brand_color": "<string>",
    "text_color": "<string>",
    "bg_color": "<string>",
    "font_heading": "<string>",
    "font_body": "<string>",
    "style_notes": "<string>",
    "tone": "<string>",
    "company_description": "<string>",
    "industry": "<string>",
    "example_copy": [
      "<string>"
    ],
    "default_header": {},
    "default_footer": {},
    "default_theme": {},
    "physical_address": "<string>",
    "company_name": "<string>",
    "source_url": "<string>",
    "last_scraped_at": "2023-11-07T05:31:56Z",
    "links": [
      {
        "url": "<string>",
        "icon": "<string>",
        "title": "<string>"
      }
    ],
    "logo": "<string>",
    "complete": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

API key (nskey_live_...) or JWT token. API key is checked first; if not found, falls back to Devise JWT authentication.

Body

application/json
​
name
string
​
avatar
string

Signed blob ID

​
banner
string

Signed blob ID

​
email_from_name
string
​
email_from_email
string<email>
​
email_reply_to
string<email>
​
test_email_recipients
string<email>[]
Maximum array length: 5

Response

Updated account

​
id
integer
​
name
string | null
​
avatar
string | null

Signed blob ID

​
banner
string | null

Signed blob ID

​
comped
boolean
​
account_tier
enum<string>
Available options:
free,
paid,
trusted
​
onboarding_state
object

JSONB — keys are step names, values are completion metadata

​
onboarding
object
​
domain_verified
boolean
​
can_send
boolean
​
using_sandbox
boolean
​
sandbox_email
string | null
​
sandbox_monthly_cap
integer
​
sandbox_sends_remaining
integer
​
capabilities
object
​
spend_cap_monthly_cents
integer | null
​
billing
object
​
email_from_name
string | null
​
email_from_email
string | null
​
email_reply_to
string | null
​
test_email_recipients
string<email>[]
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
brand
object