API Reference

Users

Create user

users().create(UserCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : UserCreateResponse

POST/api/v1/users

Create user

ParametersExpand Collapse

params: UserCreateParams

xEnvironment: XEnvironment

SANDBOX("sandbox")

PRODUCTION("production")

email: String

formatemail

firstName: String

lastName: String

password: String

formatpassword

ReturnsExpand Collapse

class UserCreateResponse:

status: String

userId: String

formatuuid

Create user

Kotlin

unfold_more

TypeScript

Java

Kotlin

Go

C#

package com.rails.api.example

import com.rails.api.client.RailsClient
import com.rails.api.client.okhttp.RailsOkHttpClient
import com.rails.api.models.users.UserCreateParams
import com.rails.api.models.users.UserCreateResponse

fun main() {
    val client: RailsClient = RailsOkHttpClient.fromEnv()

    val params: UserCreateParams = UserCreateParams.builder()
        .xEnvironment(UserCreateParams.XEnvironment.SANDBOX)
        .email("dev@stainless.com")
        .firstName("first_name")
        .lastName("last_name")
        .password("password")
        .build()
    val user: UserCreateResponse = client.users().create(params)
}

200 example

{
  "status": "status",
  "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}

Returns Examples

200 example

{
  "status": "status",
  "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}