Replace user's address permissions

The PUT /users/{userId}/permissions/addresses endpoint replaces the user’s address permissions for the user matching the user ID provided.

Request parameters

Query parameters

The endpoint accepts the following query parameters:

userID

The user ID of the required user.

Request body parameters

The endpoint requires an addressPermissions object in JSON format as in the request body.

Example request body

{
  "addressPermissions": [
    {
      "addressId": "1d75b21f-6d94-4477-9ba7-513a30bfc21d",
      "addressName": "Main line"
    },
    {
      "addressId": "fd6e3099-8673-4b11-865b-2e15ec80911a",
      "addressName": "Callback line"
    }
  ]
}

where:

• addressPermissions. The user’s address permissions.
  
  • addressId. The unique ID of the address that the user has access to.
    
  • addressName. The name the address that the user has access to.

Responses

Successful response

Successful requests return a 200 Success code.