API v1 ReferenceUsers

Creates a new contact info for the user with the specified id.

Creates a new contact info for the user with the specified id.

Required Permissions
The user must be an admin or the creator or have user-master-data:write permissions.

Path parameters

userIdUUIDRequired

The id of the user.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
labelstring or nullOptional>=0 characters<=1000 characters

The label of the contact info. Only necessary if type ‘custom’ is used.

valuestring or nullOptional>=0 characters<=1000 characters

The value of the contact info.

typestring or nullOptional>=0 characters<=25 characters

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

subTypestring or nullOptional>=0 characters<=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 nullOptional>=0 characters<=1000 characters

The first Address line of the address.

addressLine2string or nullOptional>=0 characters<=100 characters

The second address line of the contact info.

zipCodestring or nullOptional>=0 characters<=100 characters

The Zipcode of the contact info.

citystring or nullOptional>=0 characters<=100 characters

The city of the contact info.

statestring or nullOptional>=0 characters<=100 characters

The state of the contact info.

countrystring or nullOptional>=0 characters<=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 nullOptional>=0 characters<=1000 characters

The label of the contact info. Only necessary if type ‘custom’ is used.

valuestring or nullOptional>=0 characters<=1000 characters

The value of the contact info.

typestring or nullOptional>=0 characters<=25 characters

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

subTypestring or nullOptional>=0 characters<=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 nullOptional>=0 characters<=1000 characters

The first Address line of the address.

addressLine2string or nullOptional>=0 characters<=100 characters

The second address line of the contact info.

zipCodestring or nullOptional>=0 characters<=100 characters

The Zipcode of the contact info.

citystring or nullOptional>=0 characters<=100 characters

The city of the contact info.

statestring or nullOptional>=0 characters<=100 characters

The state of the contact info.

countrystring or nullOptional>=0 characters<=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.

idUUIDOptional

The Id of the contact info.

isDeletedbooleanOptional

Whether the user has been deleted.

createdOndatetimeOptional

The creation date.

createdByUUID or nullOptional

The id of the user who created the entity.

updatedOndatetimeOptional

The date when the entity was updated.

updatedByUUID or nullOptional

the id of the user who updated the entity.