Get CRM Events
GET /obp/v7.0.0/banks/BANK_ID/crm-events
OBPv1.4.0-getCrmEvents Roles: CanGetCrmEvents(per bank) Customer
Returns every CRM event recorded at the bank BANK_ID, for all customers. Each event includes the customer's name and number, the category, channel, scheduled and actual dates, and the detail and result notes.
Authentication is Required, and the User needs the Role CanGetCrmEvents at the bank.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields (11)
- actual_date
- 2020-01-27
- bank_id
- gh.29.uk
- category
- channel
- crm_events
- customer_name
- customer_number
- 5987953
- detail
- id
- d8839721-ad8f-45dd-9f78-2080414b93f9
- result
- scheduled_date
- 2020-01-27
Example success response
{
"crm_events": [
{
"id": "5995d6a2-01b3-423c-a173-5481df49bdaf",
"bank_id": "gh.29.uk",
"customer_name": "String",
"customer_number": "5987953",
"category": "String",
"detail": "String",
"channel": "String",
"scheduled_date": "1100-01-01T00:00:00Z",
"actual_date": "1100-01-01T00:00:00Z",
"result": "String"
}
]
}Possible errors (5)
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20006: User is missing one or more roles:
- No CRM Events available.
- OBP-50000: Unknown Error.