Admin APIs

Add a Brand

POST /brands
Api key auth

Add a new brand, with an optional logo. The logo should be uploaded as a file, Use multipart/form-data content type.

Body

  • brand object
    Hide brand attributes Show brand attributes object
    • handle string
    • title string
    • description string | null

Body

  • brand[handle] string
  • brand[title] string
  • brand[description] string

Responses

  • 201 application/json

    Brand created

    Hide response attribute Show response attribute object
    • brand object
      Hide brand attributes Show brand attributes object
      • id string(guid)

        System generated unique identifier. Don't include this in POST request body.

      • handle string
      • title string
      • description string | null
      • created_at string(date-time)
      • updated_at string(date-time)
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • error string

      401: Invalid Credentials

      404: Resource not found

      422: Unprocessable Entity

    • details string

      404: empty

      401: The credentials presented are not valid to access this resource
  • 422 application/json

    Unprocessable Entity

    Hide response attributes Show response attributes object
    • error string

      401: Invalid Credentials

      404: Resource not found

      422: Unprocessable Entity

    • details string

      404: empty

      401: The credentials presented are not valid to access this resource
POST /brands 
curl \
 --request POST 'https://stg.getfoundation.com/api/external/v1/brands' \
 --header "X-API-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"brand":{"handle":"acme-corp","title":"Acme Corp","description":"string"}}'
curl \
 --request POST 'https://stg.getfoundation.com/api/external/v1/brands' \
 --header "X-API-Key: $API_KEY" \
 --header "Content-Type: multipart/form-data" \
 --form "brand[logo]=@file" \
 --form "brand[handle]=string" \
 --form "brand[title]=string" \
 --form "brand[description]=string"
Request examples 
{
  "brand": {
    "handle": "acme-corp",
    "title": "Acme Corp",
    "description": "string"
  }
}
Response examples (201) 
{
  "brand": {
    "id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
    "handle": "acme-corp",
    "title": "Acme Corp",
    "description": "string",
    "logo": "https://acme-corp.com/logo.png",
    "created_at": "2025-05-04T09:42:00Z",
    "updated_at": "2025-05-04T09:42:00Z"
  }
}
Response examples (401) 
{
  "error": "string",
  "details": "string"
}
Response examples (422) 
{
  "error": "string",
  "details": "string"
}