YOyousign
User

Update a User

Changed on

Updates a given User. Any parameters not provided are left unchanged.

patch/users/{userId}

Request

Path parameters

userIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

User Id

Request body

role'admin' | 'member'

New role assigned to the User. It can be member or admin.

activeboolean

If true, the User will be activated; if false, the User will be suspended.

Response

OK

idstring uuid required
first_namestring nullable required
last_namestring nullable required
emailstring email required
phone_numberstring nullable required

E.164 format

localestring required
avatarstring nullable required
job_titlestring nullable required
is_activeboolean required
created_atstring date-time required
role'owner' | 'admin' | 'workspace_admin' | 'member' required

The role the User holds in the Organization.

workspace_admin is part of an unreleased feature. It cannot be assigned through the API, and its name, type and behavior may change before release. Do not use it.

status'invited' | 'signed_up' | 'verified' | 'completed' required
source'app' | 'public_api' required

The application used to create the User

Example response

{
  "id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
  "first_name": "John",
  "last_name": "Doe",
  "email": "email@example.com",
  "phone_number": "+447123456789",
  "locale": "en",
  "avatar": "https://example.com/users/123456/avatar",
  "job_title": "Worker",
  "created_at": "2024-01-18T22:59:00Z",
  "workspaces": [
    {
      "id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c"
    }
  ],
  "source": "public_api"
}

Changes

  • d70860094a83Revision changes
    • breaking

      the response property const value completed was removed for the status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • warning

      added the new completed enum value to the response property for the response status

    • warning

      added the new invited enum value to the response property for the response status

    • warning

      added the new owner enum value to the response property for the response status

    • warning

      added the new signed_up enum value to the response property for the response status

    • warning

      added the new verified enum value to the response property for the response status

    • warning

      added the new workspace_admin enum value to the response property for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status