Skip to main content

user.update

patch/v1/user

user.update

Request​

Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 255
          },
          "email": {
            "type": "string",
            "format": "email"
          },
          "company": {
            "type": "string",
            "maxLength": 255
          },
          "timezone": {
            "type": "string"
          },
          "notification_preferences": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "title": "UserUpdateRequest"
      }
    }
  }
}

Responses

200No description
Schema Structure
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "company": {
          "type": [
            "string",
            "null"
          ]
        },
        "timezone": {
          "type": "string"
        },
        "role": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "string",
              "enum": [
                "user"
              ]
            }
          ]
        },
        "credits": {
          "type": "number"
        },
        "plan": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "string",
              "enum": [
                "free"
              ]
            }
          ]
        },
        "avatar": {
          "type": [
            "string",
            "null"
          ]
        },
        "avatar_url": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "name",
        "email",
        "company",
        "timezone",
        "role",
        "credits",
        "plan",
        "avatar",
        "avatar_url"
      ],
      "title": "UserResource"
    }
  },
  "required": [
    "success",
    "data"
  ]
}
403Authorization error
Schema Structure
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}
422Validation error
Schema Structure
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Errors overview."
    },
    "errors": {
      "type": "object",
      "description": "A detailed description of each field that failed validation.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "message",
    "errors"
  ]
}