v1

latestOpenAPI 3.0.0Apache 2.02026-07-2410185524.2 KB
Interactions

add interaction

Creates a new interaction

For custom components:

RaiselyComponents.api.all('interactions').post(data = {}, params = {}, headers = {}) => Promise<{result}>

:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper

post/interactions

Query parameters

privateboolean

Returns the full record when authenticated

Headers

Authorizationstring

A valid HTTP Bearer token, required to access private records.

Request body

Example request

{
  "data": {
    "categoryUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "userUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
  }
}

Response

The newly created interaction

Example response

{
  "data": {
    "action": "created",
    "categoryUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "createdAt": "2020-12-03T06:52:46.330Z",
    "internalOnly": true,
    "organisationUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "recordUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "tokenUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "userUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "category": {
      "createdAt": "2020-12-03T06:52:46.330Z",
      "isCore": true,
      "path": "example-path",
      "priority": 12345,
      "updatedAt": "2020-12-03T06:52:46.330Z",
      "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
    }
  }
}