> ## 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.

# Go back to the Flow brand

> Takes your brand down: your organisations, their employees, emails, payslips and your web addresses show the Flow brand again, within 15 minutes (your own web address within a minute). Answers the revision that was live. Every revision stays in your history, so republishing one brings your brand back; the draft is not changed. 404 `branding_not_published` when nothing is live, 409 `concurrent_change` when somebody published at the same moment.



## OpenAPI

````yaml /api-reference/specs/administration.json delete /customer/branding
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:
  /customer/branding:
    delete:
      tags:
        - Branding
      summary: Go back to the Flow brand
      description: >-
        Takes your brand down: your organisations, their employees, emails,
        payslips and your web addresses show the Flow brand again, within 15
        minutes (your own web address within a minute). Answers the revision
        that was live. Every revision stays in your history, so republishing one
        brings your brand back; the draft is not changed. 404
        `branding_not_published` when nothing is live, 409 `concurrent_change`
        when somebody published at the same moment.
      operationId: UnpublishBranding
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingRevisionResponseResponseBody'
        '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'
components:
  schemas:
    BrandingRevisionResponseResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/BrandingRevisionResponseContentResponse'
        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
    BrandingRevisionResponseContentResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BrandingRevisionResponse'
        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
    BrandingRevisionResponse:
      type: object
      properties:
        brandRevision:
          type: string
          description: Sorts by the time it was published.
        settings:
          $ref: '#/components/schemas/BrandingSettingsResponse'
        publishedDate:
          type: string
        publishedBy:
          type: string
        republishedFrom:
          type: string
          description: The older revision this one copied, when it was a republish.
          nullable: true
      additionalProperties: false
      description: One published snapshot. Revisions never change once written.
    ContentMetadataResponse:
      type: object
      properties:
        dateFormat:
          type: string
        dateTimeFormat:
          type: string
        paginationToken:
          type: string
          nullable: true
      additionalProperties: false
    BrandingSettingsResponse:
      type: object
      properties:
        productName:
          type: string
          description: 2 to 40 characters. Shown in titles, emails and documents.
          nullable: true
        primaryColour:
          type: string
          description: Hex colour, `#RRGGBB`.
          nullable: true
        primaryForegroundColour:
          type: string
          description: >-
            Optional; derived when null. Must reach WCAG AA 4.5:1 on the primary
            colour.
          nullable: true
        accentColour:
          type: string
          nullable: true
        fontSource:
          enum:
            - Curated
            - Uploaded
          type: string
          description: Where the app font comes from.
        fontCuratedKey:
          type: string
          description: >-
            One of FlowPayroll.Administration.Api.Enums.CuratedFontKeys when
            FontSource is `Curated`.
          nullable: true
        fontFamily:
          type: string
          description: Display family name of an uploaded font.
          nullable: true
        fontRegularAssetId:
          type: string
          nullable: true
        fontMediumAssetId:
          type: string
          nullable: true
        fontBoldAssetId:
          type: string
          nullable: true
        fontLicenceConfirmedBy:
          type: string
          description: Who confirmed the account holds a web licence for the uploaded font.
          nullable: true
        fontLicenceConfirmedDate:
          type: string
          nullable: true
        logoAssetId:
          type: string
          description: The account logo (SVG), from `POST /customer/branding/assets`.
          nullable: true
        iconAssetId:
          type: string
          description: The square icon (SVG) the favicon set is derived from.
          nullable: true
        supportEmail:
          type: string
          nullable: true
        supportUrl:
          type: string
          nullable: true
        privacyUrl:
          type: string
          nullable: true
        termsUrl:
          type: string
          nullable: true
        helpLinksFallback:
          enum:
            - Hide
            - FlowGuides
          type: string
          description: What a help link does when the account has no support website.
        emailFromName:
          type: string
          nullable: true
        emailFromAddress:
          type: string
          nullable: true
        emailSenderOverrides:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/EmailSenderResponse'
        emailReplyTo:
          type: string
          nullable: true
        emailFooterText:
          type: string
          nullable: true
        legalFooter:
          type: string
          description: Registered name, number and office. Up to 300 characters.
          nullable: true
        documentsShowLogo:
          type: boolean
        documentsUseBrandColour:
          type: boolean
        appShowsProductName:
          type: boolean
        signInShowsProductName:
          type: boolean
        emailsShowProductName:
          type: boolean
        documentsShowProductName:
          type: boolean
        logoDarkAssetId:
          type: string
          description: The logo on a dark background; the light one is used when null.
          nullable: true
        iconDarkAssetId:
          type: string
          description: The icon on a dark background; the light one is used when null.
          nullable: true
        loadingStyle:
          enum:
            - Spinner
            - Icon
            - Animation
          type: string
          description: What the app shows while it waits.
        loadingAnimationAssetId:
          type: string
          description: The animated SVG for `Animation`.
          nullable: true
        loadingAnimationDarkAssetId:
          type: string
          description: The animation on a dark background; the light one is used when null.
          nullable: true
        emailButtonShape:
          enum:
            - Rounded
            - Square
            - Pill
          type: string
          description: The corners of the buttons in emails.
        emailHeaderStyle:
          enum:
            - Plain
            - BrandBar
          type: string
          description: How the top of each email looks.
      additionalProperties: false
      description: >-
        The fields an account sets for its brand. Flat on purpose: the draft
        PATCH is a JSON Merge Patch of

        exactly this shape, so a field reads and writes under the same name.
    EmailSenderResponse:
      type: object
      properties:
        fromName:
          type: string
          nullable: true
        fromAddress:
          type: string
          nullable: true
        replyTo:
          type: string
          nullable: true
      additionalProperties: false
      description: 'One email''s own sender: a null field uses the account''s default.'
  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.