Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Authentication can be done by using a bearer token in the Authorization header. This is done using the following format Authorization: Bearer {token}.

Path Parameters

​
tenantId
string<uuid>
required

Id of the tenant

Body

application/json

New interaction body

A new interaction. The shape of details depends on the type. For integrations registering messages from debtors or other parties, use the Debtor note variant.

​
direction
enum<string>
required

The direction of the interaction. Use INCOMING for messages received from a debtor or another party.

Available options:
INCOMING,
OUTGOING
​
minVisibilityRole
enum<string>
required

The minimum role that can see the interaction. Use client if the interaction should be visible to the creditor but not the debtor.

Available options:
alternative-contact,
debtor,
client,
caseworker,
admin,
super-admin
​
type
enum<string>
required

A message from a debtor or another party, for example a submitted contact form.

Available options:
DEBTOR NOTE
​
details
object
required

Free-form structured data about the message, for example the fields of a submitted form.

​
state
enum<string>

The state of the interaction. For INCOMING interactions use MAPPED when referenceId is set and UNMAPPED when the interaction could not be matched to a case (HANDLED and DELETED are set by caseworkers). PENDING, QUEUED, SENT and CANCELLED apply to OUTGOING interactions. Defaults to MAPPED/UNMAPPED for incoming interactions based on referenceId.

Available options:
UNMAPPED,
MAPPED,
HANDLED,
DELETED,
PENDING,
QUEUED,
SENT,
CANCELLED
​
referenceId
string<uuid> | null

Id of the entity the interaction belongs to, typically a case id. Can be null if the interaction could not be matched to a case.

​
referenceType
enum<string> | null

The type of the reference. Use case when referenceId is a case id.

Available options:
debtor,
case,
tribunal-case,
creditor,
customer,
collector,
case-voucher,
billing-voucher,
billing,
workflow,
template,
null
​
notes
string | null

The content of the interaction as HTML. The HTML is sanitized server side.

​
attachments
(string<uuid> | object)[] | null

Files to attach to the interaction, as file ids or file objects. Files can be uploaded with the create file endpoint and must belong to the tenant.

Id of a file to attach

​
createdAt
string<date-time> | null

Time the interaction was created. Defaults to now.

Response

Successful operation

​
id
string<uuid>

Id of the created interaction