Create User
Creates a user with the specified details.
This API performs an upsert (insert or update) for a user. There is no need to check that a user exists before calling
this API as it will either insert the user if it doesn't already exist or update it if it does based on the uid. A
user is updated if the given uid is already associated with an identified user. Otherwise, a new user is created.
This request can be made idempotent.
Verifying that a user has been created in Fullstory
If you'd like additional confirmation that the user has been created, you can make a Get User request using the id in the Create User response.
If the user was created successfully, a user will be returned and the response will include an app_url field that deep links to that user’s profile card in
Fullstory. You can also query for the user with the List Users endpoint and get an app_url, provided that the user was
created with a uid or email property.
The user will not be available in search/analytics reports in Fullstory until they have some activity associated with them (sessions or events).
Header Parameters
Optional header for making the request idempotent
Request Body required
- Up to 500 unique properties are allowed.
- Property names must be a sequence of alphanumeric characters A-Z, a-z, or 0-9 and underscores ("_").
- Property names must start with an alphabetic character (A-Z or a-z).
- The maximum property name length is 512 characters.
- Property values may also contain nested objects. Properties within nested objects must still conform to the naming requirements. For nested objects, the property name including the dotted concatenation of all its parent properties must still be under the length limit of 512 characters.
- Property values have a maximum size of 8192 bytes. If the value for the property is larger than this limit, the property will be rejected.
Possible values: <= 256 characters
The application-specific ID you've given to the user
Possible values: <= 256 characters
The nice-looking name for this user
Possible values: <= 128 characters
The email address associated with this user
Properties that provide additional information about your user.
schema object optional
Optional schema declaration, to define the structure of the data and override Fullstory's default type inference.
A mapping of field names to their corresponding types.
A successful response.
Schema
The Fullstory assigned user ID
{
"id": "987654321"
}
Returned when invalid input has been provided. Fix the issue and retry.
Schema
Long form description of what went wrong
A short snake-cased value that is safe to handle programmatically
{
"message": "uid is required",
"code": "required_field"
}
Returned when access to the resource is unauthorized.
Schema
Long form description of what went wrong
A short snake-cased value that is safe to handle programmatically
{
"message": "access is unauthorized",
"code": "unauthorized"
}
Returned when access is not allowed due to insufficient permissions.
Schema
Long form description of what went wrong
A short snake-cased value that is safe to handle programmatically
{
"message": "insufficient permissions",
"code": "forbidden"
}
Returned when the resource does not exist.
Schema
Long form description of what went wrong
A short snake-cased value that is safe to handle programmatically
{
"message": "Requested resource does not exist",
"code": "resource_not_found"
}
Returned when the client has exceeded the rate limit for this endpoint. A Retry-After header will be included with the response. This header will contain the number of seconds that you should wait before attempting to send another request.
Schema
Long form description of what went wrong
A short snake-cased value that is safe to handle programmatically
{
"message": "Too many requests. Client has exceeded the rate limit for this endpoint.",
"code": "too_many_requests"
}
Returned when a server error is encountered
Schema
Long form description of what went wrong
A short snake-cased value that is safe to handle programmatically
{
"message": "Server error was encountered",
"code": "server_error"
}