Update one 'UserProfile' entity

PUT 
/user-profile/:id

Update a single existing 'UserProfile' entity. Returns a full updated entity including (optional) modification metadata.

Request

Path Parameters

id integerrequired

The id tof the object to update

Query Parameters

force boolean

Forces the update even if '_etag' is missing or not matching.

application/json

Body

required

id integer

The unique entity id - must be a positive integer

is_deleted boolean

If the entity has been soft-deleted this value is true

created_at date-time
The creation time for this entity or mapping value
Example: 1970-01-01T00:00:00.000Z
created_by number
The creator user id of this entity or mapping value - or zero if created by the system
Example: 0
modified_at date-time
The last modification time for this entity or mapping value
Example: 1970-01-01T00:00:00.000Z
modified_by number
The id of the user who last modified or undeleted this entity or mapping value - or zero if modified by the system
Example: 0
deleted_at date-time
The soft-deletion time for this entity or mapping value
Example: 1970-01-01T00:00:00.000Z
deleted_by number
The id of the user who deleted this entity or mapping value - or zero if deleted by the system
Example: 0
_etag stringrequired

A tag for detecting conflicting modifications - current value (may be empty) must be passed along in an update (or update must be forced)

user_id integer

The global user id for this profile

email string

The user's primary email address for this organization

job_title stringnullable
An optional job title or organizational role description
Example:
display_name string

The user's display name in this organization

picture_data string
User profile picture encoded as base64
Example:
display_language stringnullable
The display language to use (e.g. en, de) - defaults to browser settings
Example: en
is_active boolean

True if the user is active in this organization - can be false if removed but not deleted

is_invite_pending boolean

True if the user has not yet confirmed an invite

data object
Other user-profile related settings, e.g. theme
Example: {}

Responses

200

Returns a single UserProfile

application/json

Schema

Schema

id integer

The unique entity id - must be a positive integer

is_deleted boolean

If the entity has been soft-deleted this value is true

created_at date-time
The creation time for this entity or mapping value
Example: 1970-01-01T00:00:00.000Z
created_by number
The creator user id of this entity or mapping value - or zero if created by the system
Example: 0
modified_at date-time
The last modification time for this entity or mapping value
Example: 1970-01-01T00:00:00.000Z
modified_by number
The id of the user who last modified or undeleted this entity or mapping value - or zero if modified by the system
Example: 0
deleted_at date-time
The soft-deletion time for this entity or mapping value
Example: 1970-01-01T00:00:00.000Z
deleted_by number
The id of the user who deleted this entity or mapping value - or zero if deleted by the system
Example: 0
_etag stringrequired

A tag for detecting conflicting modifications - current value (may be empty) must be passed along in an update (or update must be forced)

user_id integer

The global user id for this profile

email string

The user's primary email address for this organization

job_title stringnullable
An optional job title or organizational role description
Example:
display_name string

The user's display name in this organization

picture_data string
User profile picture encoded as base64
Example:
display_language stringnullable
The display language to use (e.g. en, de) - defaults to browser settings
Example: en
is_active boolean

True if the user is active in this organization - can be false if removed but not deleted

is_invite_pending boolean

True if the user has not yet confirmed an invite

data object
Other user-profile related settings, e.g. theme
Example: {}

Example (from schema)

{
  "id": 0,
  "is_deleted": true,
  "created_at": "1970-01-01T00:00:00.000Z",
  "created_by": 0,
  "modified_at": "1970-01-01T00:00:00.000Z",
  "modified_by": 0,
  "deleted_at": "1970-01-01T00:00:00.000Z",
  "deleted_by": 0,
  "_etag": "string",
  "user_id": 0,
  "email": "string",
  "job_title": "",
  "display_name": "string",
  "picture_data": "",
  "display_language": "en",
  "is_active": true,
  "is_invite_pending": true,
  "data": {}
}

4XX

The request failed because invalid request parameters or data were supplied or access was denied.

application/json

Schema

Schema

code string
The error code describing the general error category.
Example: API_INVALID_INPUT_DATA
status integer

The HTTP status code.

message stringrequired

The actual error message describing the error in more detail.

reqid string

The request id for following up on specific errors.

Example (from schema)

{
  "code": "API_INVALID_INPUT_DATA",
  "status": 0,
  "message": "string",
  "reqid": "string"
}

5XX

The request failed because an error occurred during processing of the request.

application/json

Schema

Schema

code string
The error code describing the general error category.
Example: API_INVALID_INPUT_DATA
status integer

The HTTP status code.

message stringrequired

The actual error message describing the error in more detail.

reqid string

The request id for following up on specific errors.

Example (from schema)

{
  "code": "API_INVALID_INPUT_DATA",
  "status": 0,
  "message": "string",
  "reqid": "string"
}

Loading...