Request a new avatar image upload

POST/users/{userId}/avatar/

API version

v2

Request method

POST

Operation ID

user-request-avatar-upload

---

Request

• userIdstring

  required

  self or the id of a user.

Responses

Format

application/json

Description

Avatar upload request was successful.

Schema documentation

• refIdstring (uuid)

  required

  The refId to be used to upload your avatar to the /v2/files/:refId route.

• rulesobject

  required

  Contstraints for the avatar image upload.

  • maxSizeInKBinteger

    required

    Maximum size in kilobytes of the avatar image.

  • mimeTypesarray of string

    required

    List of supported mime types.

    • Array[
    • *string
    ]
• propertiesobject
  • imageDimensionsobject

    Supported range of dimensions for the avatar image.

    • maxobject
      • heightinteger
      • widthinteger
    • minobject
      • heightinteger
      • widthinteger

Example

{
  "refId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "rules": {
    "maxSizeInKB": 3000,
    "mimeTypes": [
      "image/png"
    ],
    "properties": {
      "imageDimensions": {
        "max": {
          "height": 123,
          "width": 123
        },
        "min": {
          "height": 123,
          "width": 123
        }
      }
    }
  }
}

JSON Schema

{
  "properties": {
    "refId": {
      "description": "The `refId` to be used to upload your avatar to the /v2/files/:refId route.",
      "format": "uuid",
      "type": "string"
    },
    "rules": {
      "description": "Contstraints for the avatar image upload.",
      "properties": {
        "maxSizeInKB": {
          "description": "Maximum size in kilobytes of the avatar image.",
          "example": 3000,
          "type": "integer"
        },
        "mimeTypes": {
          "description": "List of supported mime types.",
          "items": {
            "example": "image/png",
            "type": "string"
          },
          "type": "array"
        },
        "properties": {
          "properties": {
            "imageDimensions": {
              "description": "Supported range of dimensions for the avatar image.",
              "properties": {
                "max": {
                  "properties": {
                    "height": {
                      "type": "integer"
                    },
                    "width": {
                      "type": "integer"
                    }
                  },
                  "type": "object"
                },
                "min": {
                  "properties": {
                    "height": {
                      "type": "integer"
                    },
                    "width": {
                      "type": "integer"
                    }
                  },
                  "type": "object"
                }
              },
              "type": "object"
            }
          },
          "type": "object"
        }
      },
      "required": [
        "mimeTypes",
        "maxSizeInKB"
      ],
      "type": "object"
    }
  },
  "required": [
    "refId",
    "rules"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/users/string/avatar

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.user.requestAvatarUpload({
  "userId": "string",
  "data": {}
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\User\RequestAvatarUpload\RequestAvatarUploadRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\User\RequestAvatarUpload\RequestAvatarUploadRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// RequestAvatarUploadRequestBody to learn how to construct a valid instance
$body = new RequestAvatarUploadRequestBody(/* TODO: ... */);

$request = (new RequestAvatarUploadRequest(
  userId: "string",
  body: $body
));
$response = $client->user()->requestAvatarUpload($request);

var_dump($response->getBody();