> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Upload a company logo

> Answers a short-lived upload form: POST `fields` and then the file (as `file`) to `url` as multipart/form-data. The server chose the storage key, the content type and the size limit. Then poll the status route with `uploadId` until it is `Ready` (use its `assetId`) or `Rejected` (show its `message`). Logos and icons: SVG, or PNG as a fallback (an icon must be square; a small PNG is scaled up where it is drawn larger), up to 1 MB. Fonts: WOFF2 up to 500 KB. Files are checked by their content, never their name; SVGs are cleaned of scripts and links to other files. An account can be given 200 upload forms a day, counted by UTC day (429 `upload_limit_reached`). Only `kind: CompanyLogo` is accepted here. 409 `organisation_has_no_account` when the organisation is not linked to an account yet.



## OpenAPI

````yaml /api-reference/specs/administration.json post /organisations/{organisationId}/branding/assets
openapi: 3.0.1
info:
  title: Administration API
  description: >-
    Manage your Flow Payroll account: the organisations it owns, the people who
    can sign in to it, the API tokens it holds, its brand, and a feed of recent
    administration activity. Every resource is scoped to the account your
    credentials belong to, so no request ever names a customer and the
    `X-Org-Id` header is not used.
  version: v1
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1/administration
security:
  - X-Auth-Token: []
tags:
  - name: Customer
    description: >-
      Your account: the customer every other resource on this API belongs to.
      Read it and rename it.
  - name: Organisations
    description: >-
      The organisations your account owns: list them with headcounts and your
      access to each, get one in full, and add one or several at a time.
  - name: Users
    description: >-
      The people who can sign in to your account: list, invite (one or many),
      resend invitations, and manage each person's direct grants and
      account-wide access.
  - name: API tokens
    description: >-
      The client credentials your integrations authenticate with: create (the
      secret is shown once), rename, rotate, revoke, and manage which
      organisations each token reaches.
  - name: Activity
    description: Recent administration actions in your account, newest first.
paths:
  /organisations/{organisationId}/branding/assets:
    post:
      tags:
        - Organisations
      summary: Upload a company logo
      description: >-
        Answers a short-lived upload form: POST `fields` and then the file (as
        `file`) to `url` as multipart/form-data. The server chose the storage
        key, the content type and the size limit. Then poll the status route
        with `uploadId` until it is `Ready` (use its `assetId`) or `Rejected`
        (show its `message`). Logos and icons: SVG, or PNG as a fallback (an
        icon must be square; a small PNG is scaled up where it is drawn larger),
        up to 1 MB. Fonts: WOFF2 up to 500 KB. Files are checked by their
        content, never their name; SVGs are cleaned of scripts and links to
        other files. An account can be given 200 upload forms a day, counted by
        UTC day (429 `upload_limit_reached`). Only `kind: CompanyLogo` is
        accepted here. 409 `organisation_has_no_account` when the organisation
        is not linked to an account yet.
      operationId: CreateOrganisationBrandingAssetUpload
      parameters:
        - name: organisationId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBrandingAssetUploadRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingAssetUploadResponseResponseBody'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
components:
  schemas:
    CreateBrandingAssetUploadRequest:
      type: object
      properties:
        kind:
          enum:
            - Logo
            - IconMark
            - CompanyLogo
            - FontRegular
            - FontMedium
            - FontBold
            - LoadingAnimation
          type: string
          description: >-
            Required. A company logo is uploaded through the organisation's own
            route.
          nullable: true
        contentType:
          type: string
          description: >-
            `image/svg+xml`, `image/png` or `font/woff2`; checked again against
            the file's content.
          nullable: true
        sizeBytes:
          type: integer
          description: The file's size, so an oversized file is refused before it is sent.
          format: int64
          nullable: true
      additionalProperties: false
      description: Asks for somewhere to upload one brand file.
    BrandingAssetUploadResponseResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/BrandingAssetUploadResponseContentResponse'
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          nullable: true
      additionalProperties: false
    ObjectResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/ObjectContentResponse'
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          nullable: true
      additionalProperties: false
    MessageWithTokenResponse:
      type: object
      properties:
        text:
          type: string
        token:
          type: string
        tokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    BrandingAssetUploadResponseContentResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BrandingAssetUploadResponse'
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssue:
      type: object
      properties:
        field:
          type: string
        reason:
          type: string
        reasonToken:
          type: string
        reasonTokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    ObjectContentResponse:
      type: object
      properties:
        data:
          nullable: true
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssueArgument:
      type: object
      properties:
        name:
          type: string
        value:
          nullable: true
      additionalProperties: false
    BrandingAssetUploadResponse:
      type: object
      properties:
        uploadId:
          type: string
          description: >-
            Ask `GET .../assets/{uploadId}` for the outcome after posting the
            file.
        kind:
          enum:
            - Logo
            - IconMark
            - CompanyLogo
            - FontRegular
            - FontMedium
            - FontBold
            - LoadingAnimation
          type: string
          description: Which brand file an upload is for.
        url:
          type: string
          description: The storage endpoint to POST the file to as `multipart/form-data`.
        fields:
          type: object
          additionalProperties:
            type: string
          description: Form fields to send unchanged, before the `file` field.
        maxSizeBytes:
          type: integer
          description: The largest file the storage will accept for this kind.
          format: int64
        expiresDate:
          type: string
      additionalProperties: false
      description: >-
        Where to send one brand file. The server chose the key; the browser only
        posts the file.
    ContentMetadataResponse:
      type: object
      properties:
        dateFormat:
          type: string
        dateTimeFormat:
          type: string
        paginationToken:
          type: string
          nullable: true
      additionalProperties: false
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      description: FlowPayroll JWT (raw token, no Bearer prefix)
      name: X-Auth-Token
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.