Smartcat

Smartcat PlaceholderFormatApi API

The PlaceholderFormatApi API from Smartcat — 2 operation(s) for placeholderformatapi.

GitHub OpenAPI

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/smartcat/refs/heads/main/authentication/smartcat-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/smartcat/refs/heads/main/openapi/smartcat-placeholderformatapi-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/smartcat/refs/heads/main/errors/smartcat-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/smartcat/refs/heads/main/conventions/smartcat-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/smartcat/refs/heads/main/conventions/smartcat-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/smartcat/refs/heads/main/data-model/smartcat-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/smartcat/refs/heads/main/asyncapi/smartcat-callbacks-webhooks.yml

OpenAPI Specification

smartcat-placeholderformatapi-api-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Smartcat Account PlaceholderFormatApi API
  version: v1
servers:
- url: /
tags:
- name: PlaceholderFormatApi
paths:
  /api/integration/v1/placeholders:
    get:
      tags:
      - PlaceholderFormatApi
      summary: Fetch all placeholder formats available in the current account
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlaceholderFormatModel'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlaceholderFormatModel'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlaceholderFormatModel'
    put:
      tags:
      - PlaceholderFormatApi
      summary: Save placeholder formats set for the specified account
      requestBody:
        description: Placeholder formats list
        content:
          application/json-patch+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PlaceholderFormatModel'
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PlaceholderFormatModel'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PlaceholderFormatModel'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PlaceholderFormatModel'
      responses:
        '204':
          description: No Content
  /api/integration/v1/placeholders/validate:
    get:
      tags:
      - PlaceholderFormatApi
      summary: Validate the provided placeholder format
      parameters:
      - name: format
        in: query
        description: Placeholder format regular expression
        schema:
          type: string
      responses:
        '204':
          description: No Content
components:
  schemas:
    PlaceholderFormatModel:
      type: object
      properties:
        regex:
          type: string
          description: Placeholder format regular expression
          nullable: true
      additionalProperties: false
      description: Model for applying a placeholder format to a client