keitaro-api-skill/references/paths/integrations_facebook_id_ca...

112 lines
2.5 KiB
YAML

get:
tags:
- Third-party integrations
security:
- ApiKeyAuth: []
parameters:
- name: id
in: path
description: Integration ID
required: true
schema:
type: integer
summary: Get assigned campaigns.
description: Returns list of assigned campaigns.
responses:
'200':
description: List of assigned campaigns
content:
application/json:
schema:
type: array
items:
$ref: ../schemas/OptionNumber.yaml
'400':
$ref: ../responses/BadRequest.yaml
'401':
$ref: ../responses/Unauthorized.yaml
'402':
$ref: ../responses/PaymentRequired.yaml
'500':
$ref: ../responses/InternalError.yaml
post:
tags:
- Third-party integrations
security:
- ApiKeyAuth: []
parameters:
- name: id
in: path
description: Integration ID
required: true
schema:
type: integer
summary: Assign to campaign
description: Assigns FB integration to campaigns.
requestBody:
description: Campaign IDs
required: true
content:
application/json:
schema:
type: object
properties:
campaign_id:
description: Campaign ID
type: integer
required:
- campaign_id
responses:
'200':
description: Successfully added
'400':
$ref: ../responses/BadRequest.yaml
'401':
$ref: ../responses/Unauthorized.yaml
'402':
$ref: ../responses/PaymentRequired.yaml
'406':
$ref: ../responses/NotAcceptable.yaml
'500':
$ref: ../responses/InternalError.yaml
delete:
tags:
- Third-party integrations
security:
- ApiKeyAuth: []
parameters:
- name: id
in: path
description: Integration ID
required: true
schema:
type: integer
requestBody:
description: Campaign ID
required: true
content:
application/json:
schema:
type: object
properties:
campaign_id:
description: Campaign ID
type: integer
required:
- campaign_id
summary: Dissociate campaign
description: Dissociates campaign
responses:
'200':
description: Successfully done
'400':
$ref: ../responses/BadRequest.yaml
'401':
$ref: ../responses/Unauthorized.yaml
'402':
$ref: ../responses/PaymentRequired.yaml
'406':
$ref: ../responses/NotAcceptable.yaml
'500':
$ref: ../responses/InternalError.yaml