Skip to main content
POST
/
v1
/
users
/
batch-update
Batch update users
curl --request POST \
  --url https://api.oneofnone.io/v1/users/batch-update \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "users": [
    {
      "email": "[email protected]",
      "phone": "<string>",
      "metadata": {}
    }
  ],
  "csv": "<string>"
}
'
{
  "message": "Users updated successfully",
  "count": 123,
  "users": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "[email protected]",
      "phone": "<string>",
      "metadata": {},
      "avatar": {
        "alt": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "file_type": "<string>",
        "id": 123,
        "poster_url": "<string>",
        "size": 123,
        "tags": [
          "<string>"
        ],
        "thumbnail_url": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "url": "<string>"
      },
      "app_id": 123,
      "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_login_at": "2023-11-07T05:31:56Z",
      "login_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Body

application/json
​
users
object[]

Array of user objects to update.

​
csv
string

CSV string containing user data. Required columns: email Optional columns: phone, metadata Example: email,phone,metadata [email protected],+1234567890,{"key":"value"}

Response

Successfully updated users.

​
message
string
required
Example:

"Users updated successfully"

​
count
integer
required

Number of users updated.

​
users
object[]
required