---
title: "Upload cover"
---

> 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 › users

`POST /v2/users/me/cover`

## Request body

_Required._

- `fileName` (`user-upload-cover.fileName`; string, required)
  - minLength 1
- `fileType` (`user-upload-cover.fileType`; string, required)
  - one of `"image/jpeg"`, `"image/jpg"`, `"image/png"`, `"image/gif"`, `"image/webp"`
- `fileSize` (`user-upload-cover.fileSize`; integer, required)
  - min 0; max 5242880
- `base64Data` (`user-upload-cover.base64Data`; string, required)
  - minLength 1

## Example request

```json
{
  "fileName": "string",
  "fileType": "image/jpeg",
  "fileSize": 0,
  "base64Data": "string"
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url https://api.sureshake.com/v2/users/me/cover \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileName": "string",
  "fileType": "image/jpeg",
  "fileSize": 0,
  "base64Data": "string"
}
'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/users/me/cover';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({fileName: 'string', fileType: 'image/jpeg', fileSize: 0, base64Data: 'string'})
};

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/users/me/cover"

payload = {
    "fileName": "string",
    "fileType": "image/jpeg",
    "fileSize": 0,
    "base64Data": "string"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "url": "string",
    "key": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`user-upload-cover.response.200.data`; object, required)
  - `url` (`user-upload-cover.response.200.data.url`; string, required)
  - `key` (`user-upload-cover.response.200.data.key`; string, required)
  - `message` (`user-upload-cover.response.200.data.message`; string, required)
- `meta` (`user-upload-cover.response.200.meta`; object, optional)
  - `timestamp` (`user-upload-cover.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

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

- `error` (`user-upload-cover.response.400.error`; object, required)
  - `code` (`user-upload-cover.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`user-upload-cover.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`user-upload-cover.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`user-upload-cover.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` (`user-upload-cover.response.401.error`; object, required)
  - `code` (`user-upload-cover.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`user-upload-cover.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`user-upload-cover.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`user-upload-cover.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` (`user-upload-cover.response.403.error`; object, required)
  - `code` (`user-upload-cover.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`user-upload-cover.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`user-upload-cover.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`user-upload-cover.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` (`user-upload-cover.response.404.error`; object, required)
  - `code` (`user-upload-cover.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`user-upload-cover.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`user-upload-cover.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`user-upload-cover.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` (`user-upload-cover.response.409.error`; object, required)
  - `code` (`user-upload-cover.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`user-upload-cover.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`user-upload-cover.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`user-upload-cover.response.409.error.traceId`; string, optional) — Unique ID for log correlation

### 422

Default Response

#### Example

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

- `error` (`user-upload-cover.response.422.error`; object, required)
  - `code` (`user-upload-cover.response.422.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`user-upload-cover.response.422.error.message`; string, required) — Human-readable error message
  - `details` (`user-upload-cover.response.422.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`user-upload-cover.response.422.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

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

- `error` (`user-upload-cover.response.500.error`; object, required)
  - `code` (`user-upload-cover.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`user-upload-cover.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`user-upload-cover.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`user-upload-cover.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` (`user-upload-cover.response.503.error`; object, required)
  - `code` (`user-upload-cover.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`user-upload-cover.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`user-upload-cover.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`user-upload-cover.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/user-upload-cover/index.md