POST /apiv2/identities/updateIdentity
Updates properties on the identity. All fields (other than password) are required, otherwise those omitted fields will be set to null. If password is provided, it will update the password for the ientity.Servers
- /
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
testModeSetting |
Integer | No |
Indicator of a MachShip user's settings in relation to viewing "test" data in the live system - eg test consignments, manifests, accounts0 = Disabled, 1 = Enabled, 2 = UserIsInTestMode Valid values:
|
owningCompanyId |
Integer | Yes | |
emailAddress |
String | Yes | |
displayName |
String | Yes | |
position |
String | No | |
id |
Integer | Yes | |
givenName |
String | Yes | |
notes |
String | No | |
businessPhone |
String | No | |
phone |
String | No | |
password |
String | No | |
familyName |
String | Yes | |
mobile |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.