Skip to main content

Input fields

extraDetails : JSONString

A JSON object of additional details regarding the item.

itemReference : String! required

Unique reference to look up the associated item (ex. UUID or primary key).

Associated item type.

number : String! required

The Collection Process Record Number.

occurredAt : DateTime

The datetime when action that resulted in the associated item happened.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "extraDetails": {"key": "value"}, "itemReference": "across-thing-rather-why-rise", "itemType": "TRANSACTIONAL_MESSAGING_TRIGGER", "number": "month-shake-voice-need-generation", "occurredAt": "2008-04-19T00:58:08.520305+00:00" }