API v1 Reference › Users

Creates contact info for the user.

POSThttps://api.awork.com/api/v1/users/{userId}/contactinfo
POST https://api.awork.com/api/v1/users/{userId}/contactinfo

Authentication

AuthorizationBearer

Send your token in the Authorization: Bearer <token> header. See Authentication for API keys and OAuth.

Path parameters

userIdstringRequired
format: uuid

The user to add contact information to.

Request body Required

The model containing contact information details including address, phone number, and type.

application/json

labelstring or nullOptional
minLength: 0 maxLength: 1000

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

valuestring or nullOptional
minLength: 0 maxLength: 1000

The value of the contact info.

typestring or nullOptional
minLength: 0 maxLength: 25

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

subTypestring or nullOptional
minLength: 0 maxLength: 25

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
minLength: 0 maxLength: 1000

The first Address line of the address.

addressLine2string or nullOptional
minLength: 0 maxLength: 100

The second address line of the contact info.

zipCodestring or nullOptional
minLength: 0 maxLength: 100

The Zipcode of the contact info.

citystring or nullOptional
minLength: 0 maxLength: 100

The city of the contact info.

statestring or nullOptional
minLength: 0 maxLength: 100

The state of the contact info.

countrystring or nullOptional
minLength: 0 maxLength: 100

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.

Responses

200 OK

application/json

labelstring or nullOptional
minLength: 0 maxLength: 1000

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

valuestring or nullOptional
minLength: 0 maxLength: 1000

The value of the contact info.

typestring or nullOptional
minLength: 0 maxLength: 25

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

subTypestring or nullOptional
minLength: 0 maxLength: 25

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
minLength: 0 maxLength: 1000

The first Address line of the address.

addressLine2string or nullOptional
minLength: 0 maxLength: 100

The second address line of the contact info.

zipCodestring or nullOptional
minLength: 0 maxLength: 100

The Zipcode of the contact info.

citystring or nullOptional
minLength: 0 maxLength: 100

The city of the contact info.

statestring or nullOptional
minLength: 0 maxLength: 100

The state of the contact info.

countrystring or nullOptional
minLength: 0 maxLength: 100

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
format: uuid

The Id of the contact info.

createdOnstringOptional
format: date-time

The creation date.

createdBystring or nullOptional
format: uuid

The id of the user who created the entity.

updatedOnstringOptional
format: date-time

The date when the entity was updated.

updatedBystring or nullOptional
format: uuid

the id of the user who updated the entity.

404 Not Found

application/json

codestringRequired
minLength: 1

The error code.

descriptionstringRequired
minLength: 1

The description of the error.

linkstringRequired
minLength: 1

The link to the API documentation page.

detailsarray of string or nullOptional

A list of details describing the error.

validationErrorsarray of object or nullOptional

If a validation error occurred, this contains the validation errors for each property.

Show 2 properties
propertystring or nullOptional

The name of the property that failed validation.

messagestring or nullOptional

The reason why this property failed validation.

traceIdstring or nullOptional

The request trace id for tracking the request.

Search documentation