Start an avatar upload for a user or the organization

POST

/api/v1/files/avatar/upload-url

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/files/avatar/upload-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "filename": "example", "mime_type": "image/jpeg", "size_bytes": 1, "target_type": "user", "target_id": "example" }'

Returns a presigned S3 PUT URL; then call POST /api/v1/files/avatar/confirm.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

filename

required

string

>= 1 characters <= 500 characters

mime_type

required

string

Allowed values: image/jpeg image/png image/webp

size_bytes

required

integer

> 0 <= 5242880

target_type

required

string

Allowed values: user org

target_id

required

string

/^[0-9a-fA-F]{24}$/

Responses

200

OK

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}