Updating a user or device's externally owned value using the xMatters API

Question

Is it possible to update a user or device's externally owned value using the xMatters API?

Environment

All versions of xMatters

Answer

Yes, as an externally owned value is a property of a user or device, by modifying a user or device in the system, you can update externally owned values using a curl command.

For example:

curl -H "Content-Type: application/json" --user username -X POST -d 
'{
  "id": "personUUID",
    "externallyOwned": true,
}' 
"https://acmeco.xmatters.com/api/xm/1/people" 

Note: You will need to have the user's UUID to be able to call them up and modify as needed. The values for externallyOwned are case sensitive, so use true or false only.

To learn about about modifying users through the xMatters API, see Modify a person.

Retroactively applying 'Externally Owned' status

The Externally Owned flag is not automatically applied to existing profiles when first enabled. To apply it to existing users, you'll need to manually update individual user profiles either through the xMatters REST API (as shown above) or perform a bulk upload through the User Upload feature. New users synchronized after enabling the option automatically receive the Externally Owned status.