update-user

restish dci update-user id

Updates user information, including name, job function, phone, language, and role.

Request

Content-Type: application/json

Schema

{
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string",
      "description": "The user's first name"
    },
    "lastName": {
      "type": "string",
      "description": "The user's last name"
    },
    "jobFunction": {
      "type": "string",
      "description": "The user's job function",
      "enum": [
        "Data Engineer / Data Analysts",
        "Executive Team",
        "Finance / Accounting",
        "Founder",
        "Legal / Purchasing",
        "Management",
        "Sales / Marketing",
        "Software / Ops Engineer"
      ]
    },
    "phone": {
      "type": "string",
      "description": "The user's country code (e.g., +44)",
      "pattern": "^\\+[0-9]+$"
    },
    "phoneExtension": {
      "type": "string",
      "description": "The user's phone extension (8-15 digits)",
      "pattern": "^[0-9]{8,15}$"
    },
    "language": {
      "type": "string",
      "description": "The user's preferred language",
      "enum": [
        "en",
        "ja"
      ]
    },
    "roleId": {
      "type": "string",
      "description": "The id of the role to assign to the user"
    }
  }
}

Responses

200 (application/json)

OK - User updated successfully.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Success message"
    },
    "user": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique id of the user"
        },
        "displayName": {
          "type": "string",
          "description": "The user's display name"
        },
        "firstName": {
          "type": "string",
          "description": "The user's first name"
        },
        "lastName": {
          "type": "string",
          "description": "The user's last name"
        },
        "email": {
          "type": "string",
          "description": "The user's email address"
        },
        "jobFunction": {
          "type": "string",
          "description": "The user's job function",
          "enum": [
            "Data Engineer / Data Analysts",
            "Executive Team",
            "Finance / Accounting",
            "Founder",
            "Legal / Purchasing",
            "Management",
            "Sales / Marketing",
            "Software / Ops Engineer"
          ]
        },
        "phone": {
          "type": "string",
          "description": "The user's country code (e.g., +44)",
          "pattern": "^\\+[0-9]+$"
        },
        "phoneExtension": {
          "type": "string",
          "description": "The user's phone extension"
        },
        "language": {
          "type": "string",
          "description": "The user's preferred language",
          "enum": [
            "en",
            "ja"
          ]
        },
        "roleId": {
          "type": "string",
          "description": "The id of the user's role"
        },
        "organizationId": {
          "type": "string",
          "description": "The id of the user's organization"
        }
      }
    }
  }
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

500 (application/json)

Internal Server Error - Something went wrong with the DoiT API server.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: update-user, updateuser