Rulebase

Rulebase Zendesk Brands API

The Zendesk Brands API from Rulebase — 5 operation(s) for zendesk brands.

GitHub OpenAPI

Operations 6

GET /zendesk_brands Get zendesk brands #
GET /zendesk_brands/{id} Get zendesk brands by id #
POST /zendesk-brands Create zendesk brands #
PATCH /zendesk-brands/{id} Update zendesk brands by id #
DELETE /zendesk-brands/{id} Delete zendesk brands by id #
POST /zendesk-brands/{id}/avatar Create zendesk brands by id avatar #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/rulebase/openapi/rulebase-zendesk-brands-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-qa-agent-evaluation-scorecard-criterion-result-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-linked-activity-thread-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-scorecard-form-params-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-evaluation-schedule-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-practice-simulation-attempt-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-practice-simulation-dry-run-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/rulebase:rulebase-zendesk-brands-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

rulebase-zendesk-brands-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Rulebase API2 Zendesk Brands API
  version: 0.0.1
tags:
- name: Zendesk Brands
paths:
  /zendesk_brands:
    get:
      parameters:
      - schema:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        required: false
        name: page[page]
        in: query
      - schema:
          type: integer
          description: Values above 100 are clamped to 100
          minimum: 1
        required: false
        name: page[limit]
        in: query
      - schema:
          type: string
        required: false
        name: organization_data_source_id
        in: query
      - schema:
          type: string
          enum:
          - active
          - inactive
        required: false
        name: tracking_status
        in: query
      - schema:
          type: string
        required: false
        name: query
        in: query
      responses:
        '200':
          description: Zendesk brands for the current organization, by name
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ZendeskBrand'
                  meta:
                    type: object
                    properties:
                      page:
                        type: object
                        properties:
                          next:
                            type: number
                            nullable: true
                          limit:
                            type: number
                          total:
                            type: number
                        required:
                        - next
                        - limit
                        - total
                    required:
                    - page
                required:
                - data
                - meta
        '503':
          description: Rails organization unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Zendesk Brands
      summary: Get zendesk brands
      x-summary-source: derived
      operationId: getZendeskBrands
      x-operation-id-source: derived
  /zendesk_brands/{id}:
    get:
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '200':
          description: A Zendesk brand
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ZendeskBrand'
                required:
                - data
        '404':
          description: Zendesk brand not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Rails organization unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Zendesk Brands
      summary: Get zendesk brands by id
      x-summary-source: derived
      operationId: getZendeskBrandsById
      x-operation-id-source: derived
  /zendesk-brands:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                zendesk_brand:
                  type: object
                  properties:
                    name:
                      type: string
                      minLength: 1
                    subdomain:
                      type: string
                      minLength: 1
                    external_id:
                      type: string
                      minLength: 1
                    organization_data_source_id:
                      type: string
                      minLength: 1
                  required:
                  - name
                  - subdomain
                  - external_id
                  - organization_data_source_id
              required:
              - zendesk_brand
      responses:
        '201':
          description: Zendesk brand created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      subdomain:
                        type: string
                      external_id:
                        type: string
                      tracking_status:
                        type: string
                        enum:
                        - active
                        - inactive
                      avatar_url:
                        type: string
                        nullable: true
                      teams_count:
                        type: integer
                      created_at:
                        type: string
                      updated_at:
                        type: string
                    required:
                    - id
                    - name
                    - subdomain
                    - external_id
                    - tracking_status
                    - avatar_url
                    - teams_count
                    - created_at
                    - updated_at
                required:
                - data
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Brand not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '409':
          description: Brand conflicts with an existing record or dependency
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Rails organization unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Zendesk Brands
      summary: Create zendesk brands
      x-summary-source: derived
      operationId: postZendeskBrands
      x-operation-id-source: derived
  /zendesk-brands/{id}:
    patch:
      parameters:
      - schema:
          type: string
          minLength: 1
        required: true
        name: id
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                zendesk_brand:
                  type: object
                  properties:
                    name:
                      type: string
                      minLength: 1
                    subdomain:
                      type: string
                      minLength: 1
                    tracking_status:
                      type: string
                      enum:
                      - active
                      - inactive
              required:
              - zendesk_brand
      responses:
        '200':
          description: Zendesk brand updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      subdomain:
                        type: string
                      external_id:
                        type: string
                      tracking_status:
                        type: string
                        enum:
                        - active
                        - inactive
                      avatar_url:
                        type: string
                        nullable: true
                      teams_count:
                        type: integer
                      created_at:
                        type: string
                      updated_at:
                        type: string
                    required:
                    - id
                    - name
                    - subdomain
                    - external_id
                    - tracking_status
                    - avatar_url
                    - teams_count
                    - created_at
                    - updated_at
                required:
                - data
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Brand not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '409':
          description: Brand conflicts with an existing record or dependency
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Rails organization unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Zendesk Brands
      summary: Update zendesk brands by id
      x-summary-source: derived
      operationId: patchZendeskBrandsById
      x-operation-id-source: derived
    delete:
      parameters:
      - schema:
          type: string
          minLength: 1
        required: true
        name: id
        in: path
      responses:
        '204':
          description: Zendesk brand deleted
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Brand not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '409':
          description: Brand conflicts with an existing record or dependency
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Rails organization unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Zendesk Brands
      summary: Delete zendesk brands by id
      x-summary-source: derived
      operationId: deleteZendeskBrandsById
      x-operation-id-source: derived
  /zendesk-brands/{id}/avatar:
    post:
      parameters:
      - schema:
          type: string
          minLength: 1
        required: true
        name: id
        in: path
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  nullable: true
      responses:
        '204':
          description: Zendesk brand avatar uploaded
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Brand not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Rails organization unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Zendesk Brands
      summary: Create zendesk brands by id avatar
      x-summary-source: derived
      operationId: postZendeskBrandsByIdAvatar
      x-operation-id-source: derived
components:
  schemas:
    ZendeskBrand:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        subdomain:
          type: string
        external_id:
          type: string
        tracking_status:
          type: string
          enum:
          - active
          - inactive
        help_center_locales:
          type: array
          nullable: true
          items:
            type: string
        avatar_url:
          type: string
          nullable: true
        teams_count:
          type: integer
        created_at:
          type: string
        updated_at:
          type: string
        organization_data_source:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            last_synced_at:
              type: string
              nullable: true
            reason_for_request_conversation_field:
              type: string
              nullable: true
            import_conversations_enabled:
              type: boolean
            data_source:
              type: object
              properties:
                id:
                  type: string
                name:
                  type: string
                type:
                  type: string
                  nullable: true
                  enum:
                  - customer_interaction
                  - notification
                  - issue_tracking
                  - knowledge_base
                  - data_warehouse
                customer_interaction_type:
                  type: string
                  nullable: true
                  enum:
                  - ticket
                  - sales_call
              required:
              - id
              - name
              - type
              - customer_interaction_type
            slack_incoming_webhook:
              type: object
              nullable: true
              properties:
                id:
                  type: string
                channel:
                  type: string
                channel_id:
                  type: string
                configuration_url:
                  type: string
              required:
              - id
              - channel
              - channel_id
              - configuration_url
            complaints_jira_request_type:
              type: object
              nullable: true
              properties:
                id:
                  type: string
                external_id:
                  type: string
                name:
                  type: string
              required:
              - id
              - external_id
              - name
          required:
          - id
          - name
          - last_synced_at
          - reason_for_request_conversation_field
          - import_conversations_enabled
          - data_source
          - slack_incoming_webhook
          - complaints_jira_request_type
      required:
      - id
      - name
      - subdomain
      - external_id
      - tracking_status
      - help_center_locales
      - avatar_url
      - teams_count
      - created_at
      - updated_at
      - organization_data_source
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Rulebase organization API key