Update Existing User
1. Find Existing User
Search for the user by external ID to retrieve their profile summary.
POST - /1211/directory/public/users/query
{
"email": null,
"phone": null,
"externalId": "KON1002"
}
{
"totalItemCount": 1,
"page": 0,
"pageSize": 0,
"items": [
{
"profile": {
"id": "1563384",
"name": "John Dough",
"description": null,
"uri": "https://api-handweave.dev.alertsense.io/api/v2/tenants/1211/directories/public/users/1563384"
},
"tenant": {
"id": "1211",
"name": "Konexus (CP)",
"description": null,
"uri": "https://api-handweave.dev.alertsense.io/api/v2/tenants/1211/directories"
},
"directory": {
"id": "public",
"name": "Public Directory",
"description": null,
"uri": "https://api-handweave.dev.alertsense.io/api/v2/tenants/1211/directories/public"
}
}
]
}
2. Retrieve Full User Profile
Retrieve the full user profile to access current contact information before making changes.
GET - /1211/directory/public/users/1563384
{
"tenantId": "1211",
"directories": [
"public"
],
"id": "1563384",
"externalId": "KON1002",
"displayName": "John Dough",
"name": {
"formatted": "John Dough",
"familyName": "Dough",
"givenName": "John",
"middleName": null,
"honorificPrefix": null,
"honorificSuffix": null
},
"contactInformation": {
"emails": {
"items": [
{
"id": "351521",
"type": "Personal",
"primary": true,
"display": "test-deterministic-user@nagdom.com",
"value": "test-deterministic-user@nagdom.com",
"verification": {
"verified": true,
"lastVerificationAttempt": null,
"verificationDate": "2026-03-20T16:55:13.327Z"
}
}
],
"totalCount": 1
},
"phones": {
"items": [
{
"id": "274699",
"type": "Work",
"primary": true,
"display": "+12081112222",
"value": "+12081112222",
"verification": {
"verified": true,
"lastVerificationAttempt": null,
"verificationDate": "2026-03-20T16:55:13.493Z"
},
"deviceType": "Landline",
"channels": [
{
"active": false,
"type": "Sms",
"status": "Unsubscribed from receiving SMS communications."
},
{
"active": true,
"type": "Voice",
"status": "Subscribed to receive communication via Voice."
}
]
}
],
"totalCount": 1
},
"mobileApps": []
},
"notificationPreferences": {
"locations": {
"items": [
{
"id": "2c5fe89b-6901-e186-aeeb-45cfd8522004",
"name": "Home Address",
"primary": true,
"address": {
"type": "Home",
"formatted": "500 E Shore Drive #240 Eagle ID 83616 US",
"streetAddress": "500 E Shore Drive #240",
"locality": "Eagle",
"region": "ID",
"postalCode": "83616",
"country": "US"
},
"geoLocation": {
"latitude": 43.6884384155273,
"longitude": -116.347312927246
}
}
],
"totalCount": 1
},
"memberships": {
"items": [],
"totalCount": 0,
"count": 0,
"isReadOnly": false
},
"preferredWrittenLanguage": null,
"preferredSpokenLanguage": null,
"locale": null,
"timezone": null
},
"organizationInformation": {
"jobTitle": null,
"department": null
},
"customInformation": null,
"authorization": null,
"legacyAuthorization": null
}
3. Add a Secondary Email Address
Add a secondary work email address to the user's profile.
Create the secondary email address second_test-deterministic-user@nagdom.com.
POST - /1211/directory/public/users/1563384/contact/emails
{
"type": "Work",
"primary": false,
"value": "second_test-deterministic-user@nagdom.com"
}
{
"id": "351522",
"type": "Work",
"primary": false,
"display": "second_test-deterministic-user@nagdom.com",
"value": "second_test-deterministic-user@nagdom.com",
"verification": {
"verified": true,
"lastVerificationAttempt": null,
"verificationDate": "2026-03-20T16:55:17.457Z"
}
}
GET - /1211/directory/public/users/1563384
{
"tenantId": "1211",
"directories": [
"public"
],
"id": "1563384",
"externalId": "KON1002",
"displayName": "John Dough",
"name": {
"formatted": "John Dough",
"familyName": "Dough",
"givenName": "John",
"middleName": null,
"honorificPrefix": null,
"honorificSuffix": null
},
"contactInformation": {
"emails": {
"items": [
{
"id": "351521",
"type": "Personal",
"primary": true,
"display": "test-deterministic-user@nagdom.com",
"value": "test-deterministic-user@nagdom.com",
"verification": {
"verified": true,
"lastVerificationAttempt": null,
"verificationDate": "2026-03-20T16:55:13.327Z"
}
},
{
"id": "351522",
"type": "Personal",
"primary": false,
"display": "second_test-deterministic-user@nagdom.com",
"value": "second_test-deterministic-user@nagdom.com",
"verification": {
"verified": true,
"lastVerificationAttempt": null,
"verificationDate": "2026-03-20T16:55:17.457Z"
}
}
],
"totalCount": 2
},
"phones": {
"items": [
{
"id": "274699",
"type": "Work",
"primary": true,
"display": "+12081112222",
"value": "+12081112222",
"verification": {
"verified": true,
"lastVerificationAttempt": null,
"verificationDate": "2026-03-20T16:55:13.493Z"
},
"deviceType": "Landline",
"channels": [
{
"active": false,
"type": "Sms",
"status": "Unsubscribed from receiving SMS communications."
},
{
"active": true,
"type": "Voice",
"status": "Subscribed to receive communication via Voice."
}
]
}
],
"totalCount": 1
},
"mobileApps": []
},
"notificationPreferences": {
"locations": {
"items": [
{
"id": "2c5fe89b-6901-e186-aeeb-45cfd8522004",
"name": "Home Address",
"primary": true,
"address": {
"type": "Home",
"formatted": "500 E Shore Drive #240 Eagle ID 83616 US",
"streetAddress": "500 E Shore Drive #240",
"locality": "Eagle",
"region": "ID",
"postalCode": "83616",
"country": "US"
},
"geoLocation": {
"latitude": 43.6884384155273,
"longitude": -116.347312927246
}
}
],
"totalCount": 1
},
"memberships": {
"items": [],
"totalCount": 0,
"count": 0,
"isReadOnly": false
},
"preferredWrittenLanguage": null,
"preferredSpokenLanguage": null,
"locale": null,
"timezone": null
},
"organizationInformation": {
"jobTitle": null,
"department": null
},
"customInformation": null,
"authorization": null,
"legacyAuthorization": null
}
4. Add a Phone Number
Add a work phone number to the user's profile.
Create the new phone number +12234567891.
POST - /1211/directory/public/users/1563384/contact/phones
{
"type": "Work",
"value": "+12234567891",
"primary": false,
"mobilePhone": true,
"verificationId": null,
"channels": null
}
{
"id": "274700",
"type": "Personal",
"primary": false,
"display": "+12234567891",
"value": "+12234567891",
"verification": {
"verified": false,
"lastVerificationAttempt": null,
"verificationDate": null
},
"deviceType": "Mobile",
"channels": [
{
"active": true,
"type": "Sms",
"status": "Subscribed to receive communication via SMS."
},
{
"active": false,
"type": "Voice",
"status": "Unsubscribed from receiving Voice communications."
}
]
}
Verify the Phone Number
The phone is unverified. Submit the verification code to complete verification.
POST - /1211/directory/public/users/1563384/contact/phones/%2B12234567891/verification/verify
{
"verificationCode": "251964"
}
{
"success": true,
"message": "Phone Number +12234567891 has been verified."
}
GET - /1211/directory/public/users/1563384/contact/phones/%2B12234567891
{
"id": "274700",
"type": "Personal",
"primary": false,
"display": "+12234567891",
"value": "+12234567891",
"verification": {
"verified": true,
"lastVerificationAttempt": null,
"verificationDate": "2026-03-20T16:55:19.133Z"
},
"deviceType": "Mobile",
"channels": [
{
"active": true,
"type": "Sms",
"status": "Subscribed to receive communication via SMS."
},
{
"active": false,
"type": "Voice",
"status": "Unsubscribed from receiving Voice communications."
}
]
}
GET - /1211/directory/public/users/1563384
{
"tenantId": "1211",
"directories": [
"public"
],
"id": "1563384",
"externalId": "KON1002",
"displayName": "John Dough",
"name": {
"formatted": "John Dough",
"familyName": "Dough",
"givenName": "John",
"middleName": null,
"honorificPrefix": null,
"honorificSuffix": null
},
"contactInformation": {
"emails": {
"items": [
{
"id": "351521",
"type": "Personal",
"primary": true,
"display": "test-deterministic-user@nagdom.com",
"value": "test-deterministic-user@nagdom.com",
"verification": {
"verified": true,
"lastVerificationAttempt": null,
"verificationDate": "2026-03-20T16:55:13.327Z"
}
},
{
"id": "351522",
"type": "Personal",
"primary": false,
"display": "second_test-deterministic-user@nagdom.com",
"value": "second_test-deterministic-user@nagdom.com",
"verification": {
"verified": true,
"lastVerificationAttempt": null,
"verificationDate": "2026-03-20T16:55:17.457Z"
}
}
],
"totalCount": 2
},
"phones": {
"items": [
{
"id": "274699",
"type": "Work",
"primary": true,
"display": "+12081112222",
"value": "+12081112222",
"verification": {
"verified": true,
"lastVerificationAttempt": null,
"verificationDate": "2026-03-20T16:55:13.493Z"
},
"deviceType": "Landline",
"channels": [
{
"active": false,
"type": "Sms",
"status": "Unsubscribed from receiving SMS communications."
},
{
"active": true,
"type": "Voice",
"status": "Subscribed to receive communication via Voice."
}
]
},
{
"id": "274700",
"type": "Personal",
"primary": false,
"display": "+12234567891",
"value": "+12234567891",
"verification": {
"verified": false,
"lastVerificationAttempt": null,
"verificationDate": null
},
"deviceType": "Mobile",
"channels": [
{
"active": true,
"type": "Sms",
"status": "Subscribed to receive communication via SMS."
},
{
"active": false,
"type": "Voice",
"status": "Unsubscribed from receiving Voice communications."
}
]
}
],
"totalCount": 2
},
"mobileApps": []
},
"notificationPreferences": {
"locations": {
"items": [
{
"id": "2c5fe89b-6901-e186-aeeb-45cfd8522004",
"name": "Home Address",
"primary": true,
"address": {
"type": "Home",
"formatted": "500 E Shore Drive #240 Eagle ID 83616 US",
"streetAddress": "500 E Shore Drive #240",
"locality": "Eagle",
"region": "ID",
"postalCode": "83616",
"country": "US"
},
"geoLocation": {
"latitude": 43.6884384155273,
"longitude": -116.347312927246
}
}
],
"totalCount": 1
},
"memberships": {
"items": [],
"totalCount": 0,
"count": 0,
"isReadOnly": false
},
"preferredWrittenLanguage": null,
"preferredSpokenLanguage": null,
"locale": null,
"timezone": null
},
"organizationInformation": {
"jobTitle": null,
"department": null
},
"customInformation": null,
"authorization": null,
"legacyAuthorization": null
}