Skip to content
/
Merchant_User_Creation

Merchant_User_Creation

Request

For an external partner to create/update a user. Fields provided will be checked against the Momnt database to ensure permissions and accounts exist. Users are created in Merchants; therefore, a merchant must exist. Users are created by Admin users; therefore, one must exist. To that end: A successful merchant onboarding workflow should have been created before this endpoint can't be used effectively.

Requirements:

  • request_user_id: There must be a user ID in our system for this POST request to succeed. That user must have permission to create subsequent users, in this specific merchant/sponsor. This user ID should have been established in previous interactions, such as pre-onboarding. Therefore, this field should be in the partner's database as well as Momnt.
Security
basicAuth
Body
required
first_namestring, <= 255 charactersrequired
last_namestring, <= 255 charactersrequired
emailstring, (email)required
phone_numberstringrequired

Format as: +15552223333

user_typestringwrite-onlyrequired
  • Admin - Admin
  • Salesperson - Salesperson
  • Salesmanager - Salesmanager
  • Salesrep - Salesrep
Enum:"Admin""Salesperson""Salesmanager""Salesrep"
user_idstring, <= 255 charactersrequired

Partner assigned user ID

request_user_idstring, <= 255 charactersrequired

Partner assigned user ID of who is requesting the creation of a new contractor user. This should be an Admin level user. Momnt Database field: user.external_user_id

external_org_idsArray of strings

When a merchant is configured with a multi-location hierarchy, this value becomes required.

curl -i -X POST \
  -u '<username>:<password>' \
  https://momnt-api-docs.redocly.app/_mock/docs/openapi/sponsor_merchant_v1/api/v1/sponsor/merchants/users/ \
  -H 'Content-Type: application/json' \
  -d '{
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "phone_number": "string",
    "user_type": "Admin",
    "user_id": "string",
    "request_user_id": "string",
    "external_org_ids": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
artis_merchant_user_idstring, (uuid)required
reward_idstringrequired
Response
{
  "artis_merchant_user_id": "53b13f48-6fe4-4e59-aa3a-101a72b5bda7",
  "reward_id": "string"
}