---
title: "Record profile view"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sureshake.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sureshake API › directory-public

`POST /v2/directory/{subjectType}/{slug}/profile-views`

## Authentication

Requires one of the following:

- 
- `BearerAuth`, http, header `Authorization`

## Path parameters

- `subjectType` (`directory-record-profile-view.path.subjectType`; string, required)
  - one of `"person"`, `"entity"`
- `slug` (`directory-record-profile-view.path.slug`; string, required)
  - minLength 1; maxLength 255

## Request body

_Required._

- `operationId` (`directory-record-profile-view.operationId`; string, required)
  - format `uuid`
- `source` (`directory-record-profile-view.source`; string, optional)
  - minLength 1; maxLength 100; default `"direct"`
- `preview` (`directory-record-profile-view.preview`; boolean, optional)
  - default `false`

## Example request

```json
{
  "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
  "source": "direct",
  "preview": false
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url 'https://api.sureshake.com/v2/directory/person/<slug>/profile-views' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
  "source": "direct",
  "preview": false
}
'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/directory/person/<slug>/profile-views';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    operationId: '3051932a-fdd2-48fa-b330-7e7d41535969',
    source: 'direct',
    preview: false
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sureshake.com/v2/directory/person/<slug>/profile-views"

payload = {
    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
    "source": "direct",
    "preview": False
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "recorded": true,
    "deduplicated": true,
    "policyExcluded": true,
    "exclusionReason": "self_or_manager",
    "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`directory-record-profile-view.response.200.data`; object, required)
  - `recorded` (`directory-record-profile-view.response.200.data.recorded`; boolean, required)
  - `deduplicated` (`directory-record-profile-view.response.200.data.deduplicated`; boolean, required)
  - `policyExcluded` (`directory-record-profile-view.response.200.data.policyExcluded`; boolean, required)
  - `exclusionReason` (`directory-record-profile-view.response.200.data.exclusionReason`; string, required, nullable)
    - one of `"self_or_manager"`, `"active_block"`, `"excluded_traffic"`, `"preview"`
  - `eventId` (`directory-record-profile-view.response.200.data.eventId`; string, required, nullable)
    - format `uuid`
- `meta` (`directory-record-profile-view.response.200.meta`; object, optional)
  - `timestamp` (`directory-record-profile-view.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-record-profile-view.response.400.error`; object, required)
  - `code` (`directory-record-profile-view.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-record-profile-view.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`directory-record-profile-view.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-record-profile-view.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-record-profile-view.response.401.error`; object, required)
  - `code` (`directory-record-profile-view.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-record-profile-view.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`directory-record-profile-view.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-record-profile-view.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-record-profile-view.response.403.error`; object, required)
  - `code` (`directory-record-profile-view.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-record-profile-view.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`directory-record-profile-view.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-record-profile-view.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 404

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-record-profile-view.response.404.error`; object, required)
  - `code` (`directory-record-profile-view.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-record-profile-view.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`directory-record-profile-view.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-record-profile-view.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 409

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-record-profile-view.response.409.error`; object, required)
  - `code` (`directory-record-profile-view.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-record-profile-view.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`directory-record-profile-view.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-record-profile-view.response.409.error.traceId`; string, optional) — Unique ID for log correlation

### 429

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-record-profile-view.response.429.error`; object, required)
  - `code` (`directory-record-profile-view.response.429.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-record-profile-view.response.429.error.message`; string, required) — Human-readable error message
  - `details` (`directory-record-profile-view.response.429.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-record-profile-view.response.429.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-record-profile-view.response.500.error`; object, required)
  - `code` (`directory-record-profile-view.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-record-profile-view.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`directory-record-profile-view.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-record-profile-view.response.500.error.traceId`; string, optional) — Unique ID for log correlation

### 503

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-record-profile-view.response.503.error`; object, required)
  - `code` (`directory-record-profile-view.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-record-profile-view.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`directory-record-profile-view.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-record-profile-view.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/directory-record-profile-view/index.md