Skip to main content

Add Organization to Workspace

POST https://deploygate.com/api/enterprises/{WORKSPACE_NAME}/organizations

Add a new Organization to the Workspace. The user to be the owner of the Organization must belong to the Workspace.


Path Params

NameTypeRequiredDescription
WORKSPACE_NAMEstringtrueWorkspace Name

Body

NameTypeRequiredDescription
owner_name_or_emailstringtrueUser name or email address of the member to be owner of the Organization
namestringtrueOrganization Name
display_namestringfalseDisplay Name
descriptionstringfalseDescription

Example

curl \
-X POST \
--url "https://deploygate.com/api/enterprises/${WORKSPACE_NAME}/organizations" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${API_TOKEN}" \
--form-string "owner_name_or_email=${OWNER_NAME_OR_EMAIL}" \
--form-string "name=${NAME}" \
--form-string "display_name=${DISPLAY_NAME}" \
--form-string "description=${DESCRIPTION}"

Result 201

{
"error": false,
"results": {
"name": "${NAME}",
"display_name": "${DISPLAY_NAME}",
"description": "${DESCRIPTION}"
}
}