Skip to content

Commit a8351e4

Browse files
Merge pull request #69 from mxenabled/bm/update_descriptions
Updates descriptions
2 parents 11b47db + 52b3573 commit a8351e4

1 file changed

Lines changed: 6 additions & 15 deletions

File tree

openapi/mx_platform_api.yml

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2673,13 +2673,11 @@ paths:
26732673
tags:
26742674
- mx_platform
26752675
post:
2676-
description: Call this endpoint to create a new user. The MX Platform API will
2677-
respond with the newly-created user object if successful. This endpoint accepts
2678-
several parameters - id, metadata, and is_disabled. Disabling a user means
2679-
that accounts and transactions associated with it will not be updated in the
2680-
background by MX. It will also restrict access to that users data until they
2681-
are no longer disabled. Users who are disabled for the entirety of an MX Platform
2682-
API billing period will not be factored into that months bill.
2676+
description: Use this endpoint to create a new user. The API will respond with
2677+
the newly-created user object if successful. Disabling a user means that accounts
2678+
and transactions associated with it will not be updated in the background
2679+
by MX. It will also restrict access to that user’s data until they are no
2680+
longer disabled.
26832681
operationId: createUser
26842682
requestBody:
26852683
content:
@@ -2740,14 +2738,7 @@ paths:
27402738
tags:
27412739
- mx_platform
27422740
put:
2743-
description: Use this endpoint to update the attributes of a specific user.
2744-
The MX Platform API will respond with the updated user object. Disabling a
2745-
user means that accounts and transactions associated with it will not be updated
2746-
in the background by MX. It will also restrict access to that users data until
2747-
they are no longer disabled. Users who are disabled for the entirety of an
2748-
MX Platform API billing period will not be factored into that months bill.
2749-
To disable a user, update it and set the is_disabled parameter to true. Set
2750-
it to false to re-enable the user.
2741+
description: Use this endpoint to update the attributes of the specified user.
27512742
operationId: updateUser
27522743
parameters:
27532744
- description: The unique id for a `user`.

0 commit comments

Comments
 (0)