Creating a User

Creating a User

Using the POST method with the Users endpoint will allow you to create a new User

POST https://edgeapi.marchex.io/marketingedge/v5/api/users

The following fields are used in this request:

ParameterTypeValueRequired?
usernamestringUnique usernameYes
namestringName of the individual the user is assigned toYes
emailstringValid email address formatYes
phonestring10 digitsNo
call_detail_levelstringOne of:
- full
- no_caller
- no_call
Yes
restrict_recording_downloadbooleanTrue, FalseNo. Default is False if not specified
rolesstringOne 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_groupsstringList of billing_group_Id values (Org Group IDs)No
group_ownersstringList of group_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 create a User

{
    "username": "new_user",
    "name": "New User",
    "email": "[email protected]",
    "phone": "",
    "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": "",
    "call_detail_level": "full",
    "restrict_recording_download": false,
    "status": "awaiting_approval",
    "last_login_date": "2022-12-14T20:36:47.3125177Z",
    "last_updated_date": "2022-12-14T20:36:47.3125177Z",
    "roles": [
        "ordering",
        "reporting",
        "browse_inventory",
        "call_record_listen"
    ],
    "access": {
        "billing_groups": [
            "24358"
        ],
        "group_owners": [
            "6600785"
        ]
    }
}