Update a User

patch

https://apis.p2pemanager.com/api/v1/users/{id}

This endpoint updates an existing User resource. It is not neccessary to include the complete replacement object in the API call; an object containing the properties that are to be changed will suffice.

Path Params

string

required

The unique identifier of the User to update.

Body Params

The User resource to be updated.

userName

string

length ≤ 255

The User's unique username.

firstName

string

length ≤ 255

The User's name.

lastName

string

length ≤ 255

The User's Surname.

string

length ≤ 255

The User's email address.

phone

string

length ≤ 255

The User's phone number without dashes, spaces, or brackets.

partner

object

Reference to the associated Partner. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

client

object

Reference to the associated Client resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

kif

object

Reference to the associated KIF resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

userRole

object

Reference to the associated User Role.

isActive

boolean

This property indicates if the User account is active or disabled. Once a user has logged into the system, their account cannot be deleted. As an alternative, their account can be set to inactive.

sendWelcomeEmail

boolean

If this property is set to 'true', the newly created user will be sent a welcome email.

Responses

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200User update response

401Unauthorized

403Forbidden

404Not found

409Invalid data

500Internal server error