Mavrck Tik Tok Campaign Fields API

The TikTokCampaignFields API from Mavrck — 1 operation(s) for tiktokcampaignfields.

OpenAPI Specification

mavrck-tiktokcampaignfields-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 1.0.0
  description: Identify your most influential customers and activate them to drive more conversions on social.
  title: MAVRCK.IO Tik Tok Campaign Fields API
servers:
- url: http://app.splashscore.com/v1
- url: https://app.splashscore.com/v1
security:
- apiKey: []
tags:
- name: TikTokCampaignFields
paths:
  /v1/tiktok-campaigns/{actionGroupId}:
    get:
      operationId: getTikTokCampaignFields
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokCampaignOrBrandInfoFieldsResponse'
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - TikTokCampaignFields
      parameters:
      - in: path
        name: actionGroupId
        required: true
        schema:
          type: number
          format: double
    put:
      operationId: upsertTikTokCampaignFields
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokCampaignOrBrandInfoFieldsResponse'
        '400':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - TikTokCampaignFields
      parameters:
      - in: path
        name: actionGroupId
        required: true
        schema:
          type: number
          format: double
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTikTokCampaignFieldsOrBrandInfoBody'
        required: true
components:
  schemas:
    TikTokBrandFields:
      properties:
        brandDescription:
          type: string
        brandName:
          type: string
      type: object
    BadRequestError:
      properties:
        details:
          properties: {}
          additionalProperties:
            additionalProperties: true
          type: object
        message:
          type: string
          enum:
          - Bad Request
      required:
      - message
      type: object
      additionalProperties: false
    TikTokCampaignOrBrandInfoFieldsResponse:
      $ref: '#/components/schemas/TikTokBrandFields'
    ForbiddenError:
      properties:
        message:
          type: string
          enum:
          - Access Forbidden
        details:
          properties: {}
          additionalProperties:
            additionalProperties: true
          type: object
      required:
      - message
      - details
      type: object
      additionalProperties: false
    CreateTikTokCampaignFieldsOrBrandInfoBody:
      $ref: '#/components/schemas/TikTokBrandFields'
    ServerError:
      properties:
        message:
          type: string
          enum:
          - Server Error
        details:
          properties: {}
          additionalProperties:
            additionalProperties: true
          type: object
      required:
      - message
      - details
      type: object
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: apiKey
      name: api-key
      in: header