Account status updated
Type: object
Domain: audit
Event: account_status_change
Version: 2
method required
Title: The HTTP Method operation
Type: string
Example:
PATCH
uri required
Title: The URI of operation
Type: string
Example:
/v2/accounts/:accountId/status
email required
Title: The email of operator
Type: string
Example:
[email protected]
roles required
Title: The operator roles
Type: array
Example:[ "backoffice-operator", "crm-operator", "geroficios-operator", "inspetoria-master", "inspetoria-operator", "itibackoffice-master", "itibackoffice-operator", "itinivel1-operator", "treasury-operator" ]
origin required
Title: The event come from
Type: string
Example:
CRM
object required
Title: The audit data message
Type: objectaccount_id required
Title: Account id
Type: integer
Example:
171238
program_id required
Title: Program ID the account belongs
Type: integer
Example:
171238
status required
Title: The account status
Type: string
Example:
BLOCKED
NORMAL
description
Title: The description
Type: string
Example:
Change by judicial determination
reason_id
Title: The Reason identifier
Type: integer
Example:
12
reason_description
Title: Reason description
Type: string
Example:
DETERMINACAO LEGAL / JUDICIAL
{
"type": "object",
"title": "Account status updated",
"required": [
"method",
"uri",
"email",
"roles",
"origin",
"object"
],
"properties": {
"method": {
"type": "string",
"title": "The HTTP Method operation",
"default": "",
"examples": [
"PATCH"
]
},
"uri": {
"type": "string",
"title": "The URI of operation",
"default": "",
"examples": [
"/v2/accounts/:accountId/status"
]
},
"email": {
"type": "string",
"title": "The email of operator",
"default": "",
"examples": [
"[email protected]"
]
},
"roles": {
"type": "array",
"title": "The operator roles",
"items": {
"type": "string",
"title": "The Roles",
"default": "",
"examples": [
"backoffice-operator",
"crm-operator",
"geroficios-operator",
"inspetoria-master",
"inspetoria-operator",
"itibackoffice-master",
"itibackoffice-operator",
"itinivel1-operator",
"treasury-operator"
]
}
},
"origin": {
"type": "string",
"title": "The event come from",
"default": "",
"examples": [
"CRM"
]
},
"object": {
"type": "object",
"title": "The audit data message",
"required": [
"account_id",
"program_id",
"status"
],
"properties": {
"account_id": {
"type": "integer",
"title": "Account id",
"examples": [
171238
]
},
"program_id": {
"type": "integer",
"title": "Program ID the account belongs",
"examples": [
171238
]
},
"status": {
"type": "string",
"title": "The account status",
"default": "",
"examples": [
"BLOCKED",
"NORMAL"
]
},
"description": {
"type": "string",
"title": "The description",
"default": "",
"examples": [
"Change by judicial determination"
]
},
"reason_id": {
"type": "integer",
"title": "The Reason identifier",
"default": 0,
"examples": [
12
]
},
"reason_description": {
"type": "string",
"title": "Reason description",
"examples": [
"DETERMINACAO LEGAL / JUDICIAL"
]
}
}
}
}
}
{
"method": "PATCH",
"uri": "/v2/accounts/:accountId/status",
"email": "[email protected]",
"roles": [
"backoffice-operator",
"crm-operator",
"geroficios-operator",
"inspetoria-master",
"inspetoria-operator",
"itibackoffice-master",
"itibackoffice-operator",
"itinivel1-operator",
"treasury-operator"
],
"origin": "CRM",
"object": {
"account_id": 171238,
"program_id": 171238,
"status": "BLOCKED",
"description": "Change by judicial determination",
"reason_id": 12,
"reason_description": "DETERMINACAO LEGAL / JUDICIAL"
}
}
Updated 6 days ago