# Organization API: Org Staff Digest

> Every Organization API operation tagged Org Staff Digest.

Source: https://www.coritan.com/docs/api/reference/organizations/org-staff-digest/

Base URL: `https://api.coritan.com/api/v1`. Paths below are complete.

To try these requests in the browser, open the [interactive Organization API reference](https://api.coritan.com/docs/org).

## Operations

| Method | Path | Summary |
| --- | --- | --- |
| GET | [`/api/v1/orgs/{org_slug}/staff/digest`](#op-get-api-v1-orgs-org-slug-staff-digest) | Which digest the signed-in member gets: off, daily or weekly |
| PUT | [`/api/v1/orgs/{org_slug}/staff/digest`](#op-put-api-v1-orgs-org-slug-staff-digest) | Choose the signed-in member's digest: off, daily or weekly |
| GET | [`/api/v1/orgs/{org_slug}/staff/digest/preview`](#op-get-api-v1-orgs-org-slug-staff-digest-preview) | Staff preview digest |

### Which digest the signed-in member gets: off, daily or weekly {#op-get-api-v1-orgs-org-slug-staff-digest}

`GET /api/v1/orgs/{org_slug}/staff/digest`

Which digest the signed-in member gets: `off`, `daily` or `weekly`.

`can_receive` is false for a role below billing, since a digest holds money
figures, and `reason` then says who can. `send_time` and `timezone` say
when it arrives: 07:00 in the brand's timezone, on Monday for a weekly one.

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `org_slug` | path | string | yes |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

### Choose the signed-in member's digest: off, daily or weekly {#op-put-api-v1-orgs-org-slug-staff-digest}

`PUT /api/v1/orgs/{org_slug}/staff/digest`

Choose the signed-in member's digest: `off`, `daily` or `weekly`.

Billing, admins and the owner can choose `daily` or `weekly`; any other
role is refused with a 403 that says who can. Anyone can choose `off`.
A digest chosen after 07:00 starts with the next send, and choosing the
word already set changes nothing.

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `org_slug` | path | string | yes |

#### Request body

`application/json` (required)

| Field | Type | Required |
| --- | --- | --- |
| `kind` | string | yes |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

### Staff preview digest {#op-get-api-v1-orgs-org-slug-staff-digest-preview}

`GET /api/v1/orgs/{org_slug}/staff/digest/preview`

The digest email the member would get, as a web page, built from the last
period that ended: yesterday for `daily`, or the last whole week (Monday to
Sunday) for `weekly`.

Needs billing or above, because a digest holds money figures. The page is
sandboxed and never cached.

#### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `org_slug` | path | string | yes |  |
| `kind` | query | string | no | Which digest to preview: daily, weekly. Default: `daily`. |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |