# Create a synchronization for a video channel

`POST /api/v1/video-channel-syncs`

Authentication (security requirement alternatives):

```json
[
  {
    "OAuth2": []
  }
]
```

- 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


Request body: application/json

Type: VideoChannelSyncCreate

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

- `externalChannelUrl` (optional)
  Type: string
  
  Example:
  
  ```json
  "https://youtube.com/c/UC_myfancychannel"
  ```

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

- `videoPrivacy` (optional)
  Type: integer
  
  Privacy of imported videos (1 = PUBLIC, 2 = UNLISTED, 3 = PRIVATE, 4 = INTERNAL).
  Password protected privacy is not supported
  

Responses:

- 200: successful operation

Content type: application/json

Type: object

- `videoChannelSync` (optional)
  Reference: [VideoChannelSync](https://sourcey-peertube.pages.dev/api-rest-reference/models/videochannelsync.md); Type: VideoChannelSync

## Examples

### cURL

```bash
curl -X POST 'https://peertube2.cpy.re/api/v1/video-channel-syncs' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "externalChannelUrl": "https://youtube.com/c/UC_myfancychannel",
  "videoChannelId": 42,
  "videoPrivacy": 0
}'
```

### JavaScript

```javascript
const body = `{
  "externalChannelUrl": "https://youtube.com/c/UC_myfancychannel",
  "videoChannelId": 42,
  "videoPrivacy": 0
}`;

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

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

### Python

```python
import requests

body = '''{
  "externalChannelUrl": "https://youtube.com/c/UC_myfancychannel",
  "videoChannelId": 42,
  "videoPrivacy": 0
}'''

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