# Add server watched words subscription

`POST /api/v1/watched-words/server/subscriptions`

Authentication (security requirement alternatives):

```json
[
  {
    "OAuth2": [
      "admin",
      "moderator"
    ]
  }
]
```

- OAuth2: oauth2. Authenticating via OAuth requires the following steps:
- Have an activated account
- [Generate] an access token for that account at `/api/v1/users/token`.
- Make requests with the *Authorization: Bearer <token\>* header
- Profit, depending on the role assigned to the account

Note that the __access token is valid for 1 day__ and is given
along with a __refresh token valid for 2 weeks__.

[Generate]: https://docs.joinpeertube.org/api/rest-getting-started
; scopes: admin, moderator

Request body: application/json

Type: object

- `url` (required)
  Type: string, url

Responses:

- 200: successful operation

Content type: application/json

Type: WatchedWordsSubscription

Schema: [WatchedWordsSubscription](https://sourcey-peertube.pages.dev/api-rest-reference/models/watchedwordssubscription.md)

- `id` (optional)
  Reference: [id](https://sourcey-peertube.pages.dev/api-rest-reference/models/id.md); Type: id
  
  minimum: 1
  
  Example:
  
  ```json
  42
  ```

- `name` (optional)
  Type: string

- `url` (optional)
  Type: string, url

- `importedWordsCount` (optional)
  Type: integer
  
  minimum: 0

- `lastSyncAt` (optional)
  Type: string, date-time; nullable
  
  Example:
  
  ```json
  "2021-05-04T08:01:01.502Z"
  ```

- `state` (optional)
  Type: object
  
  - `id` (optional)
    Type: integer
    
    enum: [1,2,3,4]
  
  - `label` (optional)
    Type: string

- `updatedAt` (optional)
  Type: string, date-time
  
  Example:
  
  ```json
  "2021-05-04T08:01:01.502Z"
  ```

- `createdAt` (optional)
  Type: string, date-time
  
  Example:
  
  ```json
  "2021-05-04T08:01:01.502Z"
  ```

- 400: cannot fetch or parse watched words URL

- 409: subscription already exists or watched words list with fetched name already exists

## Examples

### cURL

```bash
curl -X POST 'https://peertube2.cpy.re/api/v1/watched-words/server/subscriptions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "url": "https://example.com"
}'
```

### JavaScript

```javascript
const body = `{
  "url": "https://example.com"
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/watched-words/server/subscriptions', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();
```

### Python

```python
import requests

body = '''{
  "url": "https://example.com"
}'''

response = requests.post(
    'https://peertube2.cpy.re/api/v1/watched-words/server/subscriptions',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)
```