Edit Address Event

Edit Address Events in Address Exchange

Events can be updated with information. Commonly changes to description.

Editing does not scoring of event unless you change the "action" eg from 'accept' to 'deny' altering making a positive outcome a negative outcome. For example: You have event 'successful' delivery and two week later the customer informs this was unsuccessful. You can go into your event and change 'action' to 'deny' meaning unsuccessful delivery and the address is re-scored.

To neutralise an event (meaning to remove the score associated) you will need to Create Address Event the counteracting the Event you want to neutralise in description include the event uuid that is related.

Resource

where Event {uuid} is the Address Exchange EVENT UUID (not to be confused with Address UUID).

PUT    https://hosted.mastersoftgroup.com/harmony/rest/address/exchange/v1/events/{uuid}

Request

Need only to update the components requiring update. Any field will be overwritten using the updated fields.

{
  "action": "accept" or "deny",
  "description": "string",
  "newAssessment": true,
}

Response

{
    "status": "SUCCESS",
    "messages": [],
    "payload": {
        "uuid": "72d22f6e-dac3-4be8-adc8-c65f5f9a7fe4",
        "action": "accept",
        "source": {
            "id": 6,
            "code": "Trusted Source",
            "externalCode": "Trusted Source",
            "description": "Verified address with trusted source",
            "internalOnly": true,
            "descriptionOnly": false
        },
        "customerId": 1234,
        "eventDate": 1691992790015,
        "score": 10,
        "description": "Confirmed using imaginary and council records. Number on door. Alias for 25 Milton.",
        "attributes": {}
    }
}

Last updated