---
updatedAt: 2026-04-23T05:40:30.000Z
---

# Creates a new custom user property

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "API V1",
    "version": "v1"
  },
  "paths": {
    "/custom_user_properties": {
      "post": {
        "summary": "Creates a new custom user property",
        "tags": [
          "Custom User Properties"
        ],
        "parameters": [],
        "responses": {
          "201": {
            "description": "created",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer"
                        },
                        "name": {
                          "type": "string"
                        },
                        "key": {
                          "type": "string"
                        },
                        "field_type": {
                          "type": "string"
                        },
                        "options": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "label": {
                                "type": "object",
                                "additionalProperties": {
                                  "type": "string",
                                  "nullable": true
                                }
                              },
                              "value": {
                                "type": "string"
                              }
                            }
                          },
                          "nullable": true
                        },
                        "scope_id": {
                          "type": "integer"
                        },
                        "scope_type": {
                          "type": "string",
                          "enum": [
                            "Organization",
                            "Chapter"
                          ]
                        },
                        "created_at": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "validation failed",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "details": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "label": {
                    "type": "string",
                    "description": "Display label for the property"
                  },
                  "description": {
                    "type": "string",
                    "description": "Optional description of the property",
                    "nullable": true
                  },
                  "field_type": {
                    "type": "string",
                    "enum": [
                      "input",
                      "textarea",
                      "number",
                      "date",
                      "datetime",
                      "checkbox",
                      "select",
                      "radios",
                      "checkboxes"
                    ],
                    "description": "Type of field for data entry"
                  },
                  "options": {
                    "type": "array",
                    "description": "Options for select, radios, checkbox, or checkboxes field types",
                    "items": {
                      "type": "object",
                      "properties": {
                        "label": {
                          "type": "object",
                          "additionalProperties": {
                            "type": "string"
                          },
                          "description": "Multi-language labels for the option"
                        },
                        "value": {
                          "type": "string",
                          "description": "Internal value for the option"
                        }
                      }
                    },
                    "nullable": true
                  },
                  "scope_type": {
                    "type": "string",
                    "enum": [
                      "Organization",
                      "Chapter"
                    ],
                    "description": "Type of scope for the property"
                  },
                  "scope_id": {
                    "type": "integer",
                    "description": "ID of the scope for the property"
                  }
                },
                "required": [
                  "label",
                  "field_type"
                ]
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.solidarity.tech/v1",
      "variables": {
        "defaultHost": {
          "default": "api.solidarity.tech/v1"
        }
      }
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  }
}
```