> If you are setting up, configuring, or answering questions about Schematic, connect the
> Schematic MCP server before working from these pages. It reads and writes plans, features,
> entitlements, and overrides against the real account, so what you report and what you build
> match what actually exists.
>
> The server is at https://api.schematichq.com/mcp
>
> From Claude, ChatGPT, or another chat assistant, add it as a custom connector:
> https://docs.schematichq.com/working-with-ai
>
> From a coding assistant such as Claude Code, Codex, or Cursor:
> https://docs.schematichq.com/building-with-ai
>
> For clean Markdown of any page, append `.md` to the page URL. For a complete page index,
> see https://docs.schematichq.com/llms.txt

# Upsert user trait

POST https://api.schematichq.com/user-traits
Content-Type: application/json

Reference: https://docs.schematichq.com/api-reference/companies/upsert-user-trait

## Authentication

- `X-Schematic-Api-Key` header (required) — API Key authentication via header

## Request

### Body (application/json)

This endpoint expects an UpsertTraitRequestBody.

- `keys` (map from string to string, required) — Key/value pairs to identify a company or user
- `trait` (string, required) — Name of the trait to update
- `incr` (long, optional, nullable) — Amount to increment the trait by (positive or negative)
- `set` (string, optional, nullable) — Value to set the trait to
- `update_only` (boolean, optional, nullable) — Unless this is set, the company or user will be created if it does not already exist

## Response

### 200

OK

- `data` (UserDetailResponseData, required)
- `params` (UserTraitsPostResponsesContentApplicationJsonSchemaParams, required) — Input parameters

## Errors

### 400 Bad Request Error

Bad request

- `error` (string, required) — Error message

### 401 Unauthorized Error

Unauthorized

- `error` (string, required) — Error message

### 403 Forbidden Error

Forbidden

- `error` (string, required) — Error message

### 404 Not Found Error

Not found

- `error` (string, required) — Error message

### 500 Internal Server Error

Server error

- `error` (string, required) — Error message

## Types

### UserDetailResponseData

- `company_memberships` (list of CompanyMembershipDetailResponseData, required)
- `created_at` (datetime, required)
- `entity_traits` (list of EntityTraitDetailResponseData, required)
- `environment_id` (string, required)
- `id` (string, required)
- `keys` (list of EntityKeyDetailResponseData, required)
- `name` (string, required)
- `updated_at` (datetime, required)
- `last_seen_at` (datetime, optional, nullable)
- `traits` (UserDetailResponseDataTraits, optional) — A map of trait names to trait values

### UserTraitsPostResponsesContentApplicationJsonSchemaParams

Input parameters

### CompanyMembershipDetailResponseData

- `company_id` (string, required)
- `created_at` (datetime, required)
- `id` (string, required)
- `updated_at` (datetime, required)
- `user_id` (string, required)
- `company` (CompanyResponseData, optional)

### EntityTraitDetailResponseData

- `created_at` (datetime, required)
- `definition_id` (string, required)
- `environment_id` (string, required)
- `id` (string, required)
- `updated_at` (datetime, required)
- `value` (string, required)
- `definition` (EntityTraitDefinitionResponseData, optional)

### EntityKeyDetailResponseData

- `created_at` (datetime, required)
- `definition_id` (string, required)
- `entity_id` (string, required)
- `entity_type` (enum, required)
  - Allowed values: `company`, `user`
- `environment_id` (string, required)
- `id` (string, required)
- `key` (string, required)
- `updated_at` (datetime, required)
- `value` (string, required)
- `definition` (EntityKeyDefinitionResponseData, optional)

### UserDetailResponseDataTraits

A map of trait names to trait values

### CompanyResponseData

- `created_at` (datetime, required)
- `environment_id` (string, required)
- `id` (string, required)
- `name` (string, required)
- `updated_at` (datetime, required)
- `last_seen_at` (datetime, optional, nullable)
- `logo_url` (string, optional, nullable)

### EntityTraitDefinitionResponseData

- `created_at` (datetime, required)
- `display_name` (string, required)
- `entity_type` (enum, required)
  - Allowed values: `company`, `user`
- `hierarchy` (list of string, required)
- `id` (string, required)
- `trait_type` (enum, required)
  - Allowed values: `boolean`, `currency`, `date`, `number`, `string`, `url`
- `updated_at` (datetime, required)

### EntityKeyDefinitionResponseData

- `created_at` (datetime, required)
- `entity_type` (enum, required)
  - Allowed values: `company`, `user`
- `id` (string, required)
- `key` (string, required)
- `updated_at` (datetime, required)

## Examples

**Request**

```json
{
  "trait": "string"
}
```

**Response**

```json
{
  "data": {
    "company_memberships": [
      {
        "company_id": "string",
        "created_at": "2024-01-15T09:30:00Z",
        "id": "string",
        "updated_at": "2024-01-15T09:30:00Z",
        "user_id": "string",
        "company": {
          "created_at": "2024-01-15T09:30:00Z",
          "environment_id": "string",
          "id": "string",
          "name": "string",
          "updated_at": "2024-01-15T09:30:00Z",
          "last_seen_at": "2024-01-15T09:30:00Z",
          "logo_url": "string"
        }
      }
    ],
    "created_at": "2024-01-15T09:30:00Z",
    "entity_traits": [
      {
        "created_at": "2024-01-15T09:30:00Z",
        "definition_id": "string",
        "environment_id": "string",
        "id": "string",
        "updated_at": "2024-01-15T09:30:00Z",
        "value": "string",
        "definition": {
          "created_at": "2024-01-15T09:30:00Z",
          "display_name": "string",
          "entity_type": "company",
          "hierarchy": [
            "string"
          ],
          "id": "string",
          "trait_type": "boolean",
          "updated_at": "2024-01-15T09:30:00Z"
        }
      }
    ],
    "environment_id": "string",
    "id": "string",
    "keys": [
      {
        "created_at": "2024-01-15T09:30:00Z",
        "definition_id": "string",
        "entity_id": "string",
        "entity_type": "company",
        "environment_id": "string",
        "id": "string",
        "key": "string",
        "updated_at": "2024-01-15T09:30:00Z",
        "value": "string",
        "definition": {
          "created_at": "2024-01-15T09:30:00Z",
          "entity_type": "company",
          "id": "string",
          "key": "string",
          "updated_at": "2024-01-15T09:30:00Z"
        }
      }
    ],
    "name": "string",
    "updated_at": "2024-01-15T09:30:00Z",
    "last_seen_at": "2024-01-15T09:30:00Z",
    "traits": {}
  },
  "params": {}
}
```

**SDK Code**

```python
import requests

url = "https://api.schematichq.com/user-traits"

payload = { "trait": "string" }
headers = {
    "X-Schematic-Api-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.schematichq.com/user-traits';
const options = {
  method: 'POST',
  headers: {'X-Schematic-Api-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"trait":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.schematichq.com/user-traits"

	payload := strings.NewReader("{\n  \"trait\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Schematic-Api-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.schematichq.com/user-traits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Schematic-Api-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"trait\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.schematichq.com/user-traits")
  .header("X-Schematic-Api-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"trait\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.schematichq.com/user-traits', [
  'body' => '{
  "trait": "string"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Schematic-Api-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.schematichq.com/user-traits");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Schematic-Api-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"trait\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Schematic-Api-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["trait": "string"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.schematichq.com/user-traits")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```