Update User

PUT /v1/auth/users/{user_id}/update

Update a user by ID.

HTTP Request

PUT /v1/auth/users/{user_id}/update

Returns

A successful response returns a User object in user owith linked emails and phone numbers in emails and phone_numbers properties.

Path parameters

user_id string Required

Unique User ID of the user to update.

application/json

Body

first_name string

First name of the user.

Minimum length is 1.
middle_name string

Middle name of the user.

Minimum length is 1.
last_name string

Last name of the user.

Minimum length is 1.
emails array[object]

List of Emails to attach to the user.

At least 1 element.
Hide emails attribute Show emails attribute object
- email string Required
  
  Email that uniquely identifies the user.
  
  Minimum length is 1.
phone_numbers array[object]

List of E.164 formatted mobile phone numbers to attach to the user.

At least 1 element.
Hide phone_numbers attribute Show phone_numbers attribute object
- phone_number string Required
  
  E.164 formatted mobile phone number that uniquely identifies the user.
  
  Minimum length is 1.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- user_id string Required
  
  Minimum length is 1.
- phone_numbers array[object] Required
  
  At least 1 element.
  
  Hide phone_numbers attributes Show phone_numbers attributes object
  
  id string Required
  
  Minimum length is 1.
  
  verified boolean Required
  
  phone_number string Required
  
  Minimum length is 1.
  
  updated_at number Required
  
  created_at number Required
- emails array[object] Required
  
  At least 1 element.
  
  Hide emails attributes Show emails attributes object
  
  id string Required
  
  Minimum length is 1.
  
  verified boolean Required
  
  email string Required
  
  Minimum length is 1.
  
  updated_at number Required
  
  created_at number Required
- user object
  
  Hide user attributes Show user attributes object
  
  user_id string Required
  
  Minimum length is 1.
  
  first_name string Required
  
  Minimum length is 0.
  
  middle_name string Required
  
  last_name string Required
  
  Minimum length is 0.
  
  active boolean Required
  
  updated_at number Required
  
  created_at number Required
  
  emails array[object] Required
  
  At least 0 elements.
  
  Hide emails attributes Show emails attributes object
  
  id string Required
  
  Minimum length is 1.
  
  verified boolean Required
  
  email string Required
  
  Minimum length is 1.
  
  updated_at number Required
  
  created_at number Required
  
  phone_numbers array[object] Required
  
  At least 10 elements.
  
  Hide phone_numbers attributes Show phone_numbers attributes object
  
  id string Required
  
  Minimum length is 1.
  
  verified boolean Required
  
  phone_number string Required
  
  Minimum length is 1.
  
  updated_at number Required
  
  created_at number Required
  
  wallets array[object] Required
  
  At least 0 elements.
  
  Hide wallets attributes Show wallets attributes object
  
  id string Required
  
  Minimum length is 1.
  
  app_id string Required
  
  Minimum length is 1.
  
  user_id string Required
  
  Minimum length is 1.
  
  public_address string Required
  
  Minimum length is 1.
  
  wallet_type string Required
  
  Minimum length is 1.
  
  is_default boolean Required
  
  updated_at number Required
  
  created_at number Required
  
  idp_providers array[object]
  
  At least 10 elements.
  
  Hide idp_providers attributes Show idp_providers attributes object
  
  id string Required
  
  Minimum length is 1.
  
  provider string Required
  
  Minimum length is 1.
  
  provider_subject string Required
  
  Minimum length is 1.
  
  idp_type string Required
  
  Minimum length is 1.
  
  method_id string Required
  
  Minimum length is 1.
  
  method_type string Required
  
  Minimum length is 1.
  
  updated_at number Required
  
  created_at number Required
  
  totps array[object]
  
  At least 0 elements.
  
  Hide totps attributes Show totps attributes object
  
  id string Required
  
  Minimum length is 1.
  
  verified boolean Required
  
  updated_at number Required
  
  created_at number Required

PUT /v1/auth/users/{user_id}/update

curl \
 --request PUT 'https://api.streambird.io/v1/auth/users/{user_id}/update' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"emails":[{"email":"sandbox@streambird.io"}],"last_name":"Smith","first_name":"John","middle_name":"","phone_numbers":[{"phone_number":"+14152222222"}]}'

Request example

{
  "emails": [
    {
      "email": "sandbox@streambird.io"
    }
  ],
  "last_name": "Smith",
  "first_name": "John",
  "middle_name": "",
  "phone_numbers": [
    {
      "phone_number": "+14152222222"
    }
  ]
}

Response examples (200)

{
  "user": {
    "totps": [],
    "active": true,
    "emails": [
      {
        "id": "email_26AjWpEcss2YyqFh1san6Wjjs7o",
        "email": "hello@streambird.io",
        "verified": true,
        "created_at": 1646873318,
        "updated_at": 1646957196
      },
      {
        "id": "email_24oXBL3PufzHkH1Jzyjc2EXYeo7",
        "email": "sandbox@streambird.io",
        "verified": false,
        "created_at": 1642703333,
        "updated_at": 1642703333
      }
    ],
    "status": "active",
    "user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
    "wallets": [
      {
        "id": "wallet_26AjWu075gRWMnjfPglcdoD2PAQ",
        "verified": true,
        "created_at": 1646873319,
        "is_default": true,
        "updated_at": 1646873319,
        "is_imported": false,
        "wallet_type": "ethereum",
        "is_read_only": false,
        "public_address": "0x863c381a56a58370f435b0100faba94e6462b6d1"
      }
    ],
    "last_name": "",
    "created_at": 1646873318,
    "first_name": "",
    "updated_at": 1646873318,
    "middle_name": "",
    "idp_providers": [
      {
        "id": "idpuser_28SRho5nbD045LGq2btZWXhkdjN",
        "idp_type": "oauth",
        "provider": "google",
        "method_id": "email_26AjWpEcss2YyqFh1san6Wjjs7o",
        "created_at": 1651208121,
        "updated_at": 1651208121,
        "method_type": "email",
        "provider_subject": "100157402424066154830"
      }
    ],
    "phone_numbers": [
      {
        "id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
        "verified": false,
        "created_at": 1642703333,
        "updated_at": 1642703333,
        "phone_number": "+14152222222"
      }
    ],
    "webauthn_credentials": []
  },
  "emails": [
    {
      "id": "email_24oXBL3PufzHkH1Jzyjc2EXYeo7",
      "email": "sandbox@streambird.io",
      "verified": false,
      "created_at": 1642703333,
      "updated_at": 1642703333
    }
  ],
  "user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
  "phone_numbers": [
    {
      "id": "pn_24oXBLRv6BoHXbNZoTAZkAFlRsy",
      "verified": false,
      "created_at": 1642703333,
      "updated_at": 1642703333,
      "phone_number": "+14152222222"
    }
  ]
}