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

POST

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

userIdstringRequired

The id of the user.

Request

This endpoint expects an object.
labelstringOptional>=0 characters<=1000 characters

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

valuestringOptional>=0 characters<=1000 characters

The value of the contact info.

typestringOptional>=0 characters<=25 characters

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

subTypestringOptional>=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’ ].

addressLine1stringOptional>=0 characters<=1000 characters

The first Address line of the address.

addressLine2stringOptional>=0 characters<=100 characters

The second address line of the contact info.

zipCodestringOptional>=0 characters<=100 characters

The Zipcode of the contact info.

citystringOptional>=0 characters<=100 characters

The city of the contact info.

statestringOptional>=0 characters<=100 characters

The state of the contact info.

countrystringOptional>=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

labelstringOptional>=0 characters<=1000 characters

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

valuestringOptional>=0 characters<=1000 characters

The value of the contact info.

typestringOptional>=0 characters<=25 characters

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

subTypestringOptional>=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’ ].

addressLine1stringOptional>=0 characters<=1000 characters

The first Address line of the address.

addressLine2stringOptional>=0 characters<=100 characters

The second address line of the contact info.

zipCodestringOptional>=0 characters<=100 characters

The Zipcode of the contact info.

citystringOptional>=0 characters<=100 characters

The city of the contact info.

statestringOptional>=0 characters<=100 characters

The state of the contact info.

countrystringOptional>=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.

idstringOptional

The Id of the contact info.

isDeletedbooleanOptional

Whether the user has been deleted.

createdOndatetimeOptional

The creation date.

createdBystringOptional

The id of the user who created the entity.

updatedOndatetimeOptional

The date when the entity was updated.

updatedBystringOptional

the id of the user who updated the entity.

Built with