keitaro-api-skill/references/paths/offers_id_archive.yaml

49 lines
1.1 KiB
YAML

delete:
tags:
- Offers
security:
- ApiKeyAuth: []
parameters:
- name: id
in: path
description: Offer ID
required: true
schema:
type: integer
summary: Delete offer
description: Moves offer to archive
responses:
'200':
description: Offer
content:
application/json:
schema:
$ref: ../schemas/Offer.yaml
'400':
$ref: ../responses/BadRequest.yaml
'401':
$ref: ../responses/Unauthorized.yaml
'402':
$ref: ../responses/PaymentRequired.yaml
'404':
$ref: ../responses/NotFound.yaml
'500':
$ref: ../responses/InternalError.yaml
x-code-samples:
- lang: PHP
source: >-
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,
'http://example.com/admin_api/v1/offers/16/archive');
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Api-Key: your-api-key'));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
echo curl_exec($ch);