createBusinessUserAccount

Creates a new Amazon Business user account with a name and email you specified, and an autogenerated password. Adds the account holder to the specified group with an specified role. The account holder will receive an email message to update the account password.

Usage Plan:

Rate (requests per second)Burst
15

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. The preceding table indicates the default rate and burst values for this operation. For questions about your usage plan, reach out to your Amazon Business technical contact.

📘

To test this API, use any of the following sample request bodies. You can either populate the input fields below with values from these samples, or select the Edit JSON body field ({ }) in the request code box on the right and provide any of the following sample request payloads.

Example #1 - Click to expand
  {
      "accountHolder": {
          "email": "[email protected]",
          "givenName": "Test",
          "familyName": "User"
      },
      "groupId": {
          "idType": "GroupId",
          "id": "AYPNISUBADXXX"
      },
      "role": "PunchoutUser",
      "region": "DE",
      "notificationTypesToSuppress": [
          "EMAIL"
      ]
  }
Example #2 - Click to expand
{
  "accountHolder": {
      "email": "[email protected]",
      "givenName": "Test",
      "familyName": "User 2"
  },
  "groupId": {
      "idType": "GroupTag",
      "id": "111"
  },
  "role": "Administrator",
  "region": "US",
  "notificationTypesToSuppress": [
      "EMAIL"
  ]
}
Example #3 - Click to expand
{
  "accountHolder": {
      "email": "[email protected]",
      "givenName": "Test",
      "familyName": "User 3"
  },
  "groupId": {
      "idType": "GroupId",
      "id": "AGXNISUBVHXXX"
  },
  "role": "Requisitioner",
  "region": "US",
  "notificationTypesToSuppress": [
      "EMAIL"
  ]
}
Body Params

A request for creating a business user account.

accountHolder
object
required

An Amazon Business user account holder.

groupId
object
required

An Amazon Business group identifier

string
enum
required

An Amazon Business user role.

Show Details
RequisitionerBuyer role.
PunchoutUserPunchout catalog user buying role.
AdministratorAdministrator role.
FinanceFinance role.
TechTech role.
Allowed:
string
enum
required

A country or region where an Amazon Business user account will be created.

Show Details
DEamazon.de
FRamazon.fr
UKamazon.co.uk
ITamazon.it
ESamazon.es
USamazon.com
CAamazon.ca
JPamazon.co.jp
notificationTypesToSuppress
array of objects

A list of enums that specifies the types of notification to suppress.

notificationTypesToSuppress
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json