Skip to main content
PUT
/
api
/
v1
/
user
/
{user_id}
Update User Profile
curl --request PUT \
  --url 'https://api.example.com/api/v1/user/{user_id}?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "is_active": true,
  "is_superuser": true,
  "birthdate": "2023-11-07T05:31:56Z",
  "is_enterprise": true,
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phone": "<string>",
  "state": "<string>",
  "country": "<string>",
  "address": "<string>",
  "active_billing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "next_billing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "stripe_customer_id": "<string>",
  "stripe_subscription_id": "<string>",
  "stripe_subscription_status": "<string>",
  "stripe_has_payment_method": true,
  "is_trial": true,
  "used_trial": true,
  "is_paying": true,
  "stripe_last_payment_date": "2023-11-07T05:31:56Z",
  "billing_updated_at": "2023-11-07T05:31:56Z",
  "last_credits_refresh": "2023-11-07T05:31:56Z",
  "next_credits_refresh": "2023-11-07T05:31:56Z"
}
'
{
  "message": "Data updated successfully",
  "meta": {},
  "data": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_active": true,
    "is_superuser": false,
    "birthdate": "2023-11-07T05:31:56Z",
    "is_enterprise": false,
    "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "phone": "<string>",
    "state": "<string>",
    "country": "<string>",
    "address": "<string>",
    "active_billing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "next_billing_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "stripe_customer_id": "<string>",
    "stripe_subscription_id": "<string>",
    "stripe_subscription_status": "<string>",
    "stripe_has_payment_method": false,
    "is_trial": false,
    "used_trial": false,
    "is_paying": false,
    "stripe_last_payment_date": "2023-11-07T05:31:56Z",
    "billing_updated_at": "2023-11-07T05:31:56Z",
    "last_credits_refresh": "2023-11-07T05:31:56Z",
    "next_credits_refresh": "2023-11-07T05:31:56Z",
    "follower_count": 0,
    "following_count": 0
  }
}

Authorizations

​
api_key
string
query
required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Path Parameters

​
user_id
string<uuid>
required

Body

application/json
​
first_name
string | null
​
last_name
string | null
​
email
string<email> | null
​
is_active
boolean | null
​
is_superuser
boolean | null
​
birthdate
string<date-time> | null
​
is_enterprise
boolean | null
​
role_id
string<uuid> | null
​
phone
string | null
​
state
string | null
​
country
string | null
​
address
string | null
​
active_billing_plan_id
string<uuid> | null
​
next_billing_plan_id
string<uuid> | null
​
stripe_customer_id
string | null
​
stripe_subscription_id
string | null
​
stripe_subscription_status
string | null
​
stripe_has_payment_method
boolean | null
​
is_trial
boolean | null
​
used_trial
boolean | null
​
is_paying
boolean | null
​
stripe_last_payment_date
string<date-time> | null
​
billing_updated_at
string<date-time> | null
​
last_credits_refresh
string<date-time> | null
​
next_credits_refresh
string<date-time> | null

Response

Successful Response

​
message
string | null
default:Data updated successfully
​
meta
Meta · object
​
data
IUserRead · object