users

Creates contact info for the user.

Changed on

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

post/users/{userId}/contactinfo

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/users/{userId}/contactinfo
  • Auth: HTTP bearer

Path parameters

userIdstring uuid required

The user to add contact information to.

Request body

labelstring nullable

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

valuestring nullable

The value of the contact info.

typestring nullable

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

subTypestring nullable

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 nullable

The first Address line of the address.

addressLine2string nullable

The second address line of the contact info.

zipCodestring nullable

The Zipcode of the contact info.

citystring nullable

The city of the contact info.

statestring nullable

The state of the contact info.

countrystring nullable

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.

Response

OK

labelstring nullable

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

valuestring nullable

The value of the contact info.

typestring nullable

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

subTypestring nullable

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 nullable

The first Address line of the address.

addressLine2string nullable

The second address line of the contact info.

zipCodestring nullable

The Zipcode of the contact info.

citystring nullable

The city of the contact info.

statestring nullable

The state of the contact info.

countrystring nullable

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.

idstring uuid

The Id of the contact info.

createdOnstring date-time

The creation date.

createdBystring uuid nullable

The id of the user who created the entity.

updatedOnstring date-time

The date when the entity was updated.

updatedBystring uuid nullable

the id of the user who updated the entity.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PostUserContactInfoByUserId removed and replaced with users_PostUserContactInfoByUserId