Updating a User

Using the PUT method with the Users endpoint will allow you to Update an existing User

Updating a User by username - PUT https://edgeapi.marchex.io/marketingedge/v5/api/users/<username>
Updating a User by user_id - PUT https://edgeapi.marchex.io/marketingedge/v5/api/users/<user_id>

The following fields are used in this request:

Parameter	Type	Value	Required?
username	string	Unique username	Yes
name	string	Name of the individual the user is assigned to	Yes
email	string	Valid email address format	Yes
phone	string	10 digits	No
call_detail_level	string	One of: - full - no_caller - no_call	Yes
restrict_recording_download	boolean	True, False	No. Default is False if not specified
roles	string	One or more of: - administrator - org_group_admin - ordering - reporting - browse_inventory - view_stop_call_data - call_record_listen - rescue	Yes. Must have at least 1 role
billing_groups	string	List of billing_group_Id values (Org Group IDs)	No
group_owners	string	List of goup_owner_id values (Advertiser IDs)	No

📘
For more details on User Roles and assigning access see the User Roles and Access page

The following sample request can be used to update a User

{
    "username": "new_user",
    "name": "New User",
    "email": "[email protected]",
    "phone": "5559994444",
    "call_detail_level": "full",
    "restrict_recording_download": false,
    "roles": [
      "ordering",
      "reporting",
      "browse_inventory",
      "call_record_listen"
    ],
    "access": {
      "billing_groups": [
        "24358"
      ],
      "group_owners": [
        "6600785"
      ]
    }
  }

If the request is handled successfully, the following response will be returned:

{
    "user_id": "4bc45389-1daa-4d61-a86f-26f7b75d5d7a",
    "username": "new_user",
    "name": "New User",
    "email": "[email protected]",
    "phone": "5559994444",
    "call_detail_level": "full",
    "restrict_recording_download": false,
    "status": "awaiting_approval",
    "last_login_date": "2022-12-14T20:36:47.3125177",
    "last_updated_date": "2022-12-14T15:39:11.8055833-05:00",
    "roles": [
        "ordering",
        "reporting",
        "browse_inventory",
        "call_record_listen"
    ],
    "access": {
        "billing_groups": [
            "24358"
        ],
        "group_owners": [
            "6600785"
        ]
    }
}

Updated about 2 years ago