UserProfile

Create a new 'UserProfile' entity

Creates a new 'UserProfile' entity. Returns full entity with new id and (optional) creation metadata.

post/user-profile

Request

Base URL
https://app.testiny.io/api/v1
Auth
API key in header X-Api-Key
TypeScript
https://skmtc.dev/testiny/apis/testiny-api/docs/user-profile/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

idinteger

The unique entity id - must be a positive integer

is_deletedboolean

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

created_atstring date-time

The creation time for this entity or mapping value

created_bynumber

The creator user id of this entity or mapping value - or zero if created by the system

modified_atstring date-time

The last modification time for this entity or mapping value

modified_bynumber

The id of the user who last modified or undeleted this entity or mapping value - or zero if modified by the system

deleted_atstring date-time

The soft-deletion time for this entity or mapping value

deleted_bynumber

The id of the user who deleted this entity or mapping value - or zero if deleted by the system

_etagstring required

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

user_idinteger

The global user id for this profile

emailstring

The user's primary email address for this organization

job_titlestring nullable

An optional job title or organizational role description

display_namestring

The user's display name in this organization

picture_datastring

User profile picture as dataUri

display_languagestring nullable

The display language to use (e.g. en, de) - defaults to browser settings

is_activeboolean

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

is_invite_pendingboolean

True if the user has not yet confirmed an invite

dataobject

Other user-profile related settings, e.g. theme

Example request

{
  "created_at": "1970-01-01T00:00:00.000Z",
  "modified_at": "1970-01-01T00:00:00.000Z",
  "deleted_at": "1970-01-01T00:00:00.000Z",
  "picture_data": "data:image/jpeg;base64,...",
  "display_language": "en",
  "data": {}
}

Response

Returns a single UserProfile