Modify Organization Overview
If you are using Flexible/Enterprise plan, please visit this page.
PATCH https://deploygate.com/api/organizations/{ORGANIZATION_NAME}
Path Params
| Name | Type | Required | Description | 
|---|---|---|---|
| ORGANIZATION_NAME | string | true | Organization Name | 
Body
| Name | Type | Required | Description | 
|---|---|---|---|
| description | file | false | Organization's Description (Publicly Displayed) | 
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
{}