API v1 ReferenceUsers

Updates the contact info of the user with the specified id.

<Check title="Required Permissions" icon="key">The user must be an admin or the creator or have `user-master-data:write` permissions.</Check>

Authentication

AuthorizationBearer

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

Path parameters

userIdstringRequiredformat: "uuid"
The id of the user.
contactInfoIdstringRequiredformat: "uuid"
The id of the contact info.

Request

The contact info model.
labelstring or nullOptional0-1000 characters
The label of the contact info. Only necessary if type 'custom' is used.
valuestring or nullOptional0-1000 characters
The value of the contact info.
typestring or nullOptional0-25 characters

The type of the contact info. Possible values are: phone, email, address, messenger, social, urls.

subTypestring or nullOptional0-25 characters

The subtype of the contact info, Possible values are: Phone: [ ‘work’, ‘mobile’, ‘home’, ‘work Fax’, ‘fax’, ‘other’ ] Email: [ ‘work’, ‘private’, ‘other’ ] address: [ ‘work’, ‘home’, ‘other’ ] Messenger: [ ‘skype’, ‘whatsapp’, ‘other’ ] social: [ ‘facebook’, ‘twitter’, ‘xing’, ‘linkedIn’, ‘instagram’, ‘pinterest’, ‘other’ ] urls: [ ‘work’, ‘private’, ‘gitHub’, ‘other’ ].

addressLine1string or nullOptional0-1000 characters
The first Address line of the address.
addressLine2string or nullOptional0-100 characters
The second address line of the contact info.
zipCodestring or nullOptional0-100 characters
The Zipcode of the contact info.
citystring or nullOptional0-100 characters
The city of the contact info.
statestring or nullOptional0-100 characters
The state of the contact info.
countrystring or nullOptional0-100 characters
The 2 letter iso code of the country.
isAddressbooleanOptional
Flags whether this contactinfo is an address or not. If its an address, the address fields are required.

Response

OK
labelstring or null0-1000 characters
The label of the contact info. Only necessary if type 'custom' is used.
valuestring or null0-1000 characters
The value of the contact info.
typestring or null0-25 characters

The type of the contact info. Possible values are: phone, email, address, messenger, social, urls.

subTypestring or null0-25 characters

The subtype of the contact info, Possible values are: Phone: [ ‘work’, ‘mobile’, ‘home’, ‘work Fax’, ‘fax’, ‘other’ ] Email: [ ‘work’, ‘private’, ‘other’ ] address: [ ‘work’, ‘home’, ‘other’ ] Messenger: [ ‘skype’, ‘whatsapp’, ‘other’ ] social: [ ‘facebook’, ‘twitter’, ‘xing’, ‘linkedIn’, ‘instagram’, ‘pinterest’, ‘other’ ] urls: [ ‘work’, ‘private’, ‘gitHub’, ‘other’ ].

addressLine1string or null0-1000 characters
The first Address line of the address.
addressLine2string or null0-100 characters
The second address line of the contact info.
zipCodestring or null0-100 characters
The Zipcode of the contact info.
citystring or null0-100 characters
The city of the contact info.
statestring or null0-100 characters
The state of the contact info.
countrystring or null0-100 characters
The 2 letter iso code of the country.
isAddressboolean
Flags whether this contactinfo is an address or not. If its an address, the address fields are required.
idstringformat: "uuid"
The Id of the contact info.
createdOndatetime
The creation date.
createdBystring or nullformat: "uuid"
The id of the user who created the entity.
updatedOndatetime
The date when the entity was updated.
updatedBystring or nullformat: "uuid"
the id of the user who updated the entity.

Errors

400
Bad Request Error
404
Not Found Error