Skip to main content

PUT User

Overview


The following table contains important information about the PUT method in regards to updating a user.

PUT User
MethodPUT
URL or Endpoint/api/projects/projectId/users
HeadersAuthorization
ParametersprojectId
BodyCheck the request body below.

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

Request Body

{
"publicId": "string",
"firstname": "string",
"lastname": "string",
"projectName": ["string"],
"picture": "string",
"email": "string",
"isActive": true,
"role": {
"id": 0,
"name": "string",
"description": "string",
"isActive": true,
"organizationId": 0
},
"isConfirmed": true,
"defaultOrganizationId": 0
}

Information about the fields that appear in the request body are displayed in the table below.

Field NameTypeDescription
publicIdstringThe public ID of the user
firstNamestringThe first name of the user.
lastNamestringThe last name of the user.
projectNamestringThe name of the project.
pictureImageThe picture of the user.
emailstringThe email of the user.
isActiveboolIndicates whether the user is active.
roleObjectReturns the role as an object.
idinteger($int32)The id of the
namestringThe name of the role.
descriptionstringThe description of the role.
isActiveboolIndicates whether the role is active.
organizationIdinteger($int32)The id of the organization.
isConfirmedboolIndicates whether the user is confirmed.
organizationIdstringThe ID of the organization.

Response

{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": 6,
"globalId": "55b8b8b7-584a-4b9b-949a-244c6347bcc6",
"firstname": "Sejfi",
"lastname": "Hoxha",
"picture": null,
"email": "sejfi@gjirafa.com",
"isActive": true,
"role": null,
"isConfirmed": false
},
"resultInfo": null,
"statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
idinteger($int32)The id of the user
globalIdstringThe global id of the user.
firstNamestringThe first name of the user.
lastNamestringThe last name of the user.
pictureImageThe picture of the user.
emailstringThe email of the user.
isActiveboolIndicates whether the user is active.
roleObjectReturns the role as an object.
isConfirmedboolIndicates whether the user is confirmed.
resultInfostringReturns extra information about the result.
statusCodeinteger($int32)Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed