---
title: "create one or multiple brands"
method: POST
path: "/api/serviceorganizations/brands"
tags: ["brands"]
---

# create one or multiple brands

`POST /api/serviceorganizations/brands`

Create one or multiple brands

## Request body

- union
  - Brand
    - `uuid` string, uuid
    - `createdAt` string, date-time
    - `createdBy` string, uuid
    - `lastUpdatedAt` string, date-time
    - `lastUpdatedBy` string, uuid
    - `lastUpdatedByAudience` string
    - `lastUpdatedByAudienceUuid` string, uuid
    - `lastUpdatedByImpersonatedBy` string, uuid
    - `lastUpdatedByCompanyUuid` string, uuid
    - `lastUpdatedByEnterpriseUuid` string, uuid
    - `name` string, required
    - `companyUuid` string, uuid
    - `logoUrl` string, uri
    - `websiteUrl` string, uri
    - `colors` object
      - `primary` string
      - `secondary` string
    - `welcomeContent` object
      - `message` string
    - `helpContent` object
      - `message` string
    - `onboardingContent` object
      - `message` string
    - `invitationMessage` object
      - `invitationEmailEnabled` boolean
      - `invitationSmsEnabled` boolean
      - `email` object
        - `subject` string, required
        - `content` string, required
      - `sms` object
        - `content` string, required
    - `emailTemplateUuid` string, uuid, nullable
    - `hireBrandId` string, uuid
    - `originSystem` string — The system that last updated this brand (hire or wx)
    - `originUpdatedAt` string, date-time — When the brand was last updated in the origin system
  - Brand[]
    - `uuid` string, uuid
    - `createdAt` string, date-time
    - `createdBy` string, uuid
    - `lastUpdatedAt` string, date-time
    - `lastUpdatedBy` string, uuid
    - `lastUpdatedByAudience` string
    - `lastUpdatedByAudienceUuid` string, uuid
    - `lastUpdatedByImpersonatedBy` string, uuid
    - `lastUpdatedByCompanyUuid` string, uuid
    - `lastUpdatedByEnterpriseUuid` string, uuid
    - `name` string, required
    - `companyUuid` string, uuid
    - `logoUrl` string, uri
    - `websiteUrl` string, uri
    - `colors` object
      - `primary` string
      - `secondary` string
    - `welcomeContent` object
      - `message` string
    - `helpContent` object
      - `message` string
    - `onboardingContent` object
      - `message` string
    - `invitationMessage` object
      - `invitationEmailEnabled` boolean
      - `invitationSmsEnabled` boolean
      - `email` object
        - `subject` string, required
        - `content` string, required
      - `sms` object
        - `content` string, required
    - `emailTemplateUuid` string, uuid, nullable
    - `hireBrandId` string, uuid
    - `originSystem` string — The system that last updated this brand (hire or wx)
    - `originUpdatedAt` string, date-time — When the brand was last updated in the origin system

## Response `201`

One or many brand documents created. Wrapped in a JsonAPI root response.

- object
  - `data` union
    - Brand
      - `uuid` string, uuid
      - `createdAt` string, date-time
      - `createdBy` string, uuid
      - `lastUpdatedAt` string, date-time
      - `lastUpdatedBy` string, uuid
      - `lastUpdatedByAudience` string
      - `lastUpdatedByAudienceUuid` string, uuid
      - `lastUpdatedByImpersonatedBy` string, uuid
      - `lastUpdatedByCompanyUuid` string, uuid
      - `lastUpdatedByEnterpriseUuid` string, uuid
      - `name` string, required
      - `companyUuid` string, uuid
      - `logoUrl` string, uri
      - `websiteUrl` string, uri
      - `colors` object
        - `primary` string
        - `secondary` string
      - `welcomeContent` object
        - `message` string
      - `helpContent` object
        - `message` string
      - `onboardingContent` object
        - `message` string
      - `invitationMessage` object
        - `invitationEmailEnabled` boolean
        - `invitationSmsEnabled` boolean
        - `email` object
          - `subject` string, required
          - `content` string, required
        - `sms` object
          - `content` string, required
      - `emailTemplateUuid` string, uuid, nullable
      - `hireBrandId` string, uuid
      - `originSystem` string — The system that last updated this brand (hire or wx)
      - `originUpdatedAt` string, date-time — When the brand was last updated in the origin system
    - Brand[]
      - `uuid` string, uuid
      - `createdAt` string, date-time
      - `createdBy` string, uuid
      - `lastUpdatedAt` string, date-time
      - `lastUpdatedBy` string, uuid
      - `lastUpdatedByAudience` string
      - `lastUpdatedByAudienceUuid` string, uuid
      - `lastUpdatedByImpersonatedBy` string, uuid
      - `lastUpdatedByCompanyUuid` string, uuid
      - `lastUpdatedByEnterpriseUuid` string, uuid
      - `name` string, required
      - `companyUuid` string, uuid
      - `logoUrl` string, uri
      - `websiteUrl` string, uri
      - `colors` object
        - `primary` string
        - `secondary` string
      - `welcomeContent` object
        - `message` string
      - `helpContent` object
        - `message` string
      - `onboardingContent` object
        - `message` string
      - `invitationMessage` object
        - `invitationEmailEnabled` boolean
        - `invitationSmsEnabled` boolean
        - `email` object
          - `subject` string, required
          - `content` string, required
        - `sms` object
          - `content` string, required
      - `emailTemplateUuid` string, uuid, nullable
      - `hireBrandId` string, uuid
      - `originSystem` string — The system that last updated this brand (hire or wx)
      - `originUpdatedAt` string, date-time — When the brand was last updated in the origin system
  - `meta` ResponsesPartMeta
    - `timestamp` string, date-time, required
    - `verb` 'OPTION' | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE'
    - `path` string
    - `jti` string
    - `rid` string
    - `count` number
    - `status` string
    - `duration` number
    - `size` number

## Other responses

- `500` — default error response

---

[API](https://skmtc.net/fountain/apis/hire-public-api.md) · [All operations](https://skmtc.net/fountain/apis/hire-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fountain/hire-public-api/revisions/5f406c0e9462/schema)