Update a user from your addressbook
Request
PUT https://api.digital-nautic.com/v3/users/{userId}
Path parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| userId | integer | pass a user id to update the user details. |
Required |
Request body
The request body takes a complete User resource, containing the following writable properties:
{
"addressCity": "string",
"addressCountry": {},
"addressPostalCode": "string",
"addressState": "string",
"addressStreet1": "string",
"addressStreet2": "string",
"birthDate": "date",
"civility": "string",
"email": "email",
"firstName": "string",
"landlinePhone": "string",
"language": {
"code": "string",
"name": "string"
},
"lastName": "string",
"mobilePhone": "string",
"nationality": {},
"organizationName": "string",
"organizationType": "string",
"organizationVatNumber": "string"
}Properties
| Name | Type | Description | Additional |
|---|---|---|---|
| addressCity | string |
User city of residence |
|
| addressCountry | object |
Country information. |
|
| addressPostalCode | string |
User postal code of residence |
|
| addressState | string |
User state of residence |
|
| addressStreet1 | string |
User address street 1 of residence |
|
| addressStreet2 | string |
User address street 2 of residence |
Optional |
| birthDate | date |
User date of birth |
|
| civility | string |
User civility (accepted values are MS, MR, OTHER) |
|
|
User email |
|||
| firstName | string |
User first name |
|
| landlinePhone | string | Phone | |
| language | object |
User language |
|
| language.code | string |
Standard language code |
|
| language.name | string |
Language name |
|
| lastName | string |
User last name |
|
| mobilePhone | string | Phone | |
| nationality | object |
Country information. |
|
| organizationName | string |
Organization name. Necessary if the user represents an association or a society |
Optional |
| organizationType | string |
User can be an individual or can represent an association or a society (accepted values are INDIVIDUAL, SOCIETY, ASSOCIATION) |
|
| organizationVatNumber | string |
Organization VAT number. Necessary if the user represents an association or a society |
Optional |
Response
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK item updated |
User |
| 400 | Bad Request bad input parameter |
|
| 401 | Unauthorized authorization information is missing or invalid. |
|
| 404 | Not Found a user with the specified ID was not found. |