---
title: "add interaction"
method: POST
path: "/interactions"
tags: ["Interactions"]
---

# add interaction

`POST /interactions`

Creates a new **interaction**
#### For custom components:
`RaiselyComponents.api.all('interactions').post(data = {}, params = {}, headers = {}) => Promise<{result}>`

 :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper

## Query parameters

- `private` boolean

## Headers

- `Authorization` string

## Request body

- object
  - `data` object
    - `categoryUuid` string, required — The UUID of the category the interaction should belong to
    - `categoryPath` string — The path of the category the interaction should belong to. This can be supplied instead of a categoryUuid
    - `userUuid` string — The user the interaction should belong to
    - `detail` object — Additional details relating to this Raisely interaction
      - `comment` string
      - `pinned` boolean
      - `private` object
      - `public` object

## Response `200`

The newly created interaction

- object
  - `data` object
    - `action` string — `public` The action the interaction represents
    - `categoryUuid` string — `public` Unique identifier for the record
    - `context` object — `public`
    - `createdAt` string — `public` Date the record was created
    - `detail` object, required — `public` Additional details relating to this Raisely interaction
      - `comment` string — `public`
      - `createdAt` string — `public`
      - `pinned` boolean — `public`
      - `private` object — `public`
      - `public` object — `public`
      - `readOnly` boolean — `public`
      - `updatedAt` string — `public`
      - `uuid` string — `public`
    - `diff` object — `public` Additional details about the changes applied to an update (updated interaction only)
    - `externalId` string — `public`
    - `immutable` object — `public`
    - `internalOnly` boolean — `public`
    - `model` string — `public` The model represented by this interaction
    - `organisationUuid` string — `public` Unique identifier for the record
    - `recordType` string — `public` The type of record represented by this interaction
    - `recordUuid` string — `public` Unique identifier for the record
    - `tokenUuid` string — `public` Unique identifier for the record
    - `userUuid` string — `public` Unique identifier for the record
    - `uuid` string — `public` Unique identifier for the record
    - `category` NestedInteractionCategory
      - `createdAt` string — `public` Date the record was created
      - `description` string — `public`
      - `group` string — `public`
      - `isCore` boolean — `public`
      - `label` string — `public`
      - `path` string — `public` The path of this record (for alternative lookup)
      - `priority` integer — `public`
      - `updatedAt` string — `public` Date the record was last updated
      - `uuid` string — `public` Unique identifier for the record

## Other responses

- `401` — Authorization credentials were missing or invalid
- `403` — The user is authenticated, but is not allowed to perform the requested operation
- `410` — The requested record no longer exists, or that API has been deprecated
- `429` — You have made too many requests to the given endpoint, please try again later
- `500` — An unexpected error has occurred with Raisely. If the error persists you can contact support@raisely.com

---

[API](https://skmtc.net/raisely/apis/raisely-api.md) · [All operations](https://skmtc.net/raisely/apis/raisely-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/raisely/raisely-api/versions/d7f8dd294cb0/schema)