Answer5

AppResellerAccount6

AppResellerAssignment3

AppResellerCatalog2

AppResellerCompanyAssociation3

AppResellerLeads11

AppResellerOpportunities23

AppResellerOrder1

AppResellerPaymentMethod3

AppResellerQuoteVersion4

AppResellerReconciliation3

AppResellerSubscription5

Bundle3

checkoutItemDetails1

Comment5

Companies7

CompanyMemberships15

CurrencyExchangeRate4

CustomerNotification9

DataUploader3

DefaultNotificationTemplateApi5

Discount5

Domains3

Edition1

Event2

Group10

InboundEvents1

Integration4

Invitation5

Invoice7

Marketplace Product Settings5

MyApps4

Navigation1

Payment5

Payment Methods7

PaymentInstrument6

PaymentPlan3

Payments v29

Product8

Product Management API4

ProductContext2

PurchaseOrder7

Question4

Reconciliation1

Reporting3

Reporting V22

Review5

Search1

SegmentFolders15

Settings2

ShoppingCart28

SubscriptionAssignments5

Subscriptions23

Sync5

User13

UserAccounts2

User

Patch a user

Changed on Nov 6, 2026

Update ('patch') one or more fields in the user details. This only adds or updates the values for the properties that you include in the call; all other properties, and data already saved for them, are ignored

patch/account/v2/users/{userUuid}

Request

Base URL
https://marketplace.appdirect.com/api
Auth
none declared
TypeScript
https://skmtc.dev/appdirect/apis/companies/docs/account/v2/users/:userUuid/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

userUuidstring required

Unique identifier of the user assigned by the AppDirect platform

Request body

externalIdstring

External identifier of user

firstNamestring nullable

First name of user

lastNamestring nullable

Last name of user

usernamestring nullable

User name. If not provided, use the user's email address

ldapIdstring nullable

LDAP identifier of user

idpUuidstring nullable

The external identity provider's ID for the user

localestring

User locale in the standard ISO 639-1 language code + ISO 3166-1 country code format. For example: 'en_US'

currencystring

Currency

rolesstring[]

All users have ROLE_USER (end-user access). To assign the Network Manager, role use ROLE_CORPORATE_ADMIN. For company membership roles, see UserCompanyMembershipAccountV2.

Example request

{
  "firstName": "Jane",
  "lastName": "Lee",
  "currency": "USD",
  "externalId": "b34974b2-f5d6-4326-9859-5247dc42ee60",
  "locale": "en_US",
  "ldapId": "1",
  "boostUser": {
    "apsUid": "murnu8w"
  },
  "roles": [
    "ROLE_CORPORATE_ADMIN"
  ],
  "idpUuid": "c412543-1233-6547-9809-0647dc42ee51"
}

Response

Success

activatedboolean

Is this user activated

creationDatenumber

User creation date in UNIX Epoch milliseconds

emailstring

Email address

externalIdstring

External identifier of user

firstNamestring nullable

First name

lastNamestring nullable

Last name

allowLoginboolean

The user is able to log into a marketplace. By default allowLogin=true

lastSuccessfulLoginnumber

User last successful login date in UNIX Epoch milliseconds

ldapIdstring nullable

Ldap integration

idpUuidstring nullable

The external identity provider's ID for the user

localestring

User locale in the standard ISO 639-1 language code + ISO 3166-1 country code format. For example: 'en_US', 'fr_CA', and so on.

metadataobject

openidstring

OpenID URL

picturestring nullable

Profile picture URL

rolesstring[]

User roles. All responses include ROLE_USER (end-user access). If the user has the Network Manager role, this array also includes ROLE_CORPORATE_ADMIN. For company membership roles, see UserCompanyMembershipAccountV2.

userIdnumber

usernamestring nullable

User name. If not provided, use the user's email address

uuidstring

Unique identifier of the user assigned by the AppDirect platform

Example response

{
  "uuid": "8d237de5-9710-4d55-a5cc-3e8dc918c216",
  "email": "jude.doe@company8578572384.com",
  "username": "jude.doe",
  "firstName": "Jude",
  "lastName": "Doe",
  "picture": "http://localhost:8080/profilePics/img2147417701652580695.png?184b58e358f087154d94329f9000b28a",
  "activated": true,
  "allowLogin": true,
  "currency": "USD",
  "creationDate": 1398896238000,
  "lastSuccessfulLogin": 1543259363000,
  "openId": "http://localhost:8080/openid/id/2f93cb24-f7b9-433f-875e-bb0dd9b0f1c1",
  "externalId": "b34974b2-f5d6-4326-9859-5247dc42ee60",
  "idpUuid": "1d37bace-f4cf-11e6-af80-22000a9513f7",
  "locale": "en_US",
  "customAttributes": [
    {
      "name": "C5125859",
      "attributeType": "TEXT",
      "label": "Commission_Payout_ID",
      "hint": "commission_hint",
      "value": "value"
    }
  ],
  "ldapId": "1",
  "boostUser": {
    "apsUid": "murnu8w"
  },
  "roles": [
    "ROLE_USER"
  ],
  "metadata": {
    "apsUid": null
  },
  "links": [
    {
      "rel": "self",
      "href": "http://appdirect/api/account/v2/users/8d237de5-9710-4d55-a5cc-3e8dc918c216"
    },
    {
      "rel": "memberships",
      "href": "http://appdirect/api/account/v2/users/8d237de5-9710-4d55-a5cc-3e8dc918c216/memberships"
    }
  ]
}

Changes

Nov 6, 20261fc240f06971 Revision changes
- breaking
  the request's body type changed from no type to object
- breaking
  removed the media type */* for the response with the status
- breaking
  removed the media type */* for the response with the status
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property

Operation history