Update profile

patch https://app.mk.io/api/v1/user/profile

This endpoint allows certain fields within the profile to be updated.

Authentication

Authorization Bearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

specobjectUserProfileSpec_v1Required
Specification.
Show 11 propertiesHide 11 properties
companystringOptional0-1024 characters
Company.
countrystringOptional0-1024 characters
Country.
jobRolestringOptional0-1024 characters
Job Role.
namestringOptional1-1024 characters
Full name.
phoneNumberstringOptional0-1024 characters
Phone number including international dialling code

Response

200 OK
kindstringRequired
The kind of record.
metadataobjectUserMetadataRequired
Metadata.
Show 1 propertyHide 1 property
idstringRequiredformat: uuid
The unique identifier of the user.
specobjectUserProfileSpec_v1Required
Specification.
Show 11 propertiesHide 11 properties
activeOrganizationIdstringRequired
Currently selected organization.
avatarstringRequired<=200 characters
Avatar.
companystringOptional0-1024 characters
Company.
contactEmailstringRequired1-1024 characters
Contact email address
countrystringOptional0-1024 characters
Country.
featuresmap from strings to anyRequired
Internally managed set of flags indicating access to preview or new features.
Show value schemaHide value schema
[any key]any
isActivebooleanRequired
Is this user active?
jobRolestringOptional0-1024 characters
Job Role.
loginEmailstringRequired1-1024 characters
Email address used for login
namestringOptional1-1024 characters
Full name.
phoneNumberstringOptional0-1024 characters
Phone number including international dialling code

Errors

400 Bad Request
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
401 Unauthorized
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
403 Forbidden
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
404 Not Found
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
429 Too Many Requests
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
500 Internal Server Error
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code