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

66 lines
1.4 KiB
YAML

put:
tags:
- Groups
security:
- ApiKeyAuth: []
parameters:
- name: id
in: path
description: Group ID
required: true
schema:
type: integer
summary: Update Group
description: Update a Group
requestBody:
description: Update a Group
required: true
content:
application/json:
schema:
$ref: ../schemas/GroupRequest.yaml
responses:
'200':
description: Group
content:
application/json:
schema:
$ref: ../schemas/Group.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/groups/19');
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Api-Key: your-api-key'));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_POST, 1);
$params = [
'id' => 19,
'name' => 'Test Group X2',
];
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
echo curl_exec($ch);