メインコンテンツまでスキップ

グループの説明文を変更する

PATCH https://deploygate.com/api/organizations/{ORGANIZATION_NAME}


Path Params

NameTypeRequiredDescription
ORGANIZATION_NAMEstringtrueグループ名

Body

NameTypeRequiredDescription
descriptionfilefalseグループの表示上の説明文

Example

curl \
-X PATCH \
--url "https://deploygate.com/api/organizations/${ORGANIZATION_NAME}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${API_TOKEN}" \
--form-string "description=this is the new description of the group"

Result 200

{
"error": false,
"organization": {
"type": "Organization",
"name": "${ORGANIZATION_NAME}",
"description": "Updated description",
"url": "https://deploygate.com/organizations/${ORGANIZATION_NAME}"
}
}

Result 400

{}