Update a user

PUT 
https://api.freemius.com/v1/products/{product_id}/users/{user_id}.json

Auth:Bearer TokenSCOPE: PRODUCT

Product-scoped API tokens allow you to operate on the product itself. This token usually allows read-only access to the product configuration and write access to several operations on subscriptions, customers, payments, and more. For most SaaS or app integrations, this is the token you will need.

1. Go to the Freemius Developer Dashboard.
2. Open the Settings page of the relevant product.
3. Click the API & Keys tab.
4. Copy the API Bearer Authorization Token from the UI.

---

Update a user associated with your product.

Request

Path Parameters

product_id integer<int64>required
The ID of the product.
Possible values: >= 1
Example: 1234
user_id integer<int64>required
The ID of the User.
Possible values: >= 1
Example: 1234

Query Parameters

fields string
Comma separated list of fields to return in the response. If not specified, all fields are returned.
Example: id,name,slug

application/json

Bodyrequired

namestring

The name of the user (Optional).

firststring
First name of the person.
Example: Jane
laststring
Last name of the person.
Example: Doe
is_marketing_allowedbooleannullable

Whether or not the user has given their consent for marketing materials. A null value indicates that the user has not made a decision yet.

is_betaboolean

Whether or not the user has opted-in to beta versions. We do not recommend using this option anymore since it will opt-in the user to all sites/activations. Currently, sites or activations can be managed individually.

Responses

200

The product user updated data.

application/json

Schema

notestring

A note about the user. Only visible to the developer.

is_marketing_allowedbooleannullable

Whether or not the user has given their consent for marketing materials. A null value indicates that the user has not made a decision yet.

is_betaboolean

Whether or not the user has opted-in to beta versions. We do not recommend using this option anymore since it will opt-in the user to all sites/activations. Currently, sites or activations can be managed individually.

emailstring

Email address of the person.

Example: [email protected]

firststring

First name of the person.

Example: Jane

laststring

Last name of the person.

Example: Doe

picturestring

Profile picture URL.

Example: https://example.com/profile-pic.jpg

ipstring<ipv4|ipv6>nullable

The IP address (v4 or v6).

Example: 127.0.0.1

is_verifiedboolean

Whether the person is trusted or not.

Example: true

authstring

The type of authentication. If app2fa is set, the person has signed for 2FA authentication.

Possible values: [app2fa, password]

secret_keystring

The secret key associated with the entity for authorization.

Example: sk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

public_keystring

The public key associated with the entity for authorization.

Example: pk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

idstring<int64>

The unique identifier of the entity.

Possible values: >= 1

Example: 123456

createdstring<date-time>

The date and time the entity was created, under UTC timezone.

Example: 2025-01-01 00:00:00

updatedstring<date-time>nullable

The date and time the entity was updated, under UTC timezone. If null then the entity was never updated since its creation.

Example: 2025-01-01 00:00:00

grossnumber<float>

The total amount of money the user has spent on the platform.

last_login_atstring<date-time>nullable

Date and time of the last login.

Example: 2025-07-30 05:56:29

email_statusstring

The status of the last email sent to the user.

Possible values: [delivered, bounce, dropped]

401

Unauthorized access error. The request requires authentication but was not provided or the provided authentication does not satisfy the required permissions.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

Current timestamp.

Example: Thu, 11 May 2023 11:45:30 +0000

request object

This object sends back the request payload as received by the server (both from path and from body or query).

property name*any

This object sends back the request payload as received by the server (both from path and from body or query).

Example: {"beautify":true,"format":"json"}

402

The request is missing the specified argument.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

Current timestamp.

Example: Thu, 11 May 2023 11:45:30 +0000

request object

This object sends back the request payload as received by the server (both from path and from body or query).

property name*any

This object sends back the request payload as received by the server (both from path and from body or query).

Example: {"beautify":true,"format":"json"}

404

The requested resource was not found.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

Current timestamp.

Example: Thu, 11 May 2023 11:45:30 +0000

request object

This object sends back the request payload as received by the server (both from path and from body or query).

property name*any

This object sends back the request payload as received by the server (both from path and from body or query).

Example: {"beautify":true,"format":"json"}