account update
PUT
/accounts/update/{loginId}This endpoint will update account on loginId
Request
Path Params
loginId
number
required
required parameter to identify the api Gateway
Default:
1010080
Body Params application/json
accountUsername
string
required
it carries the username of the account
groupIds
array[string]
optional
isPaused
boolean
optional
flag showing if the account is paused
color
string
optional
userAccess
array [object {2}]
optional
companyId
number
optional
accessType
enum<string>
optional
Allowed values:
OMC
watermark
object
optional
position
number
optional
opacity
number
optional
size
number
optional
url
string
optional
Example
{
"accountUsername": "Food news",
"groupIds": [
"8e1169a5-8dbd-435b-972b-40e51433e21f",
"25dbb7d3-57cf-41ce-9e20-4a5660370f59"
],
"isPaused": false,
"color": "#3b5998",
"userAccess": [
{
"companyId": 103983,
"accessType": "M"
}
],
"watermark": {
"position": 1,
"opacity": 1,
"size": 1,
"url": "exampleURL"
}
}
Request samples
Responses
OK(200)
Bad Request(400)
Unauthorized(401)
Parameter Error(422)
Server Error(500)
HTTP Code: 200
Content Type : JSONapplication/json
Account updated successfully.
Data Schema
message
string
optional
Account updated successfully.
response
object
optional
loginId
number
optional
it carries the loginId of the account updated
Example
Success message 1
{
"message": "Account updated successfully.",
"response": {
"loginId": 1010234
}
}
Last modified: 18 days ago