Skip to main content

Create Organization

POST https://deploygate.com/api/organizations

Create Organization.

Caution
  • Selected users are automatically added to the owner's team.
  • Any plan have a 30-days free trial after Organization is created. If you want to continue to use after the trial period, you need to register the billing information to your Organization.

Body​

NameTypeRequiredDescription
organization_namestringtrueOrganization Name. Must be at least 3 characters and can contain alphanumeric characters and -. The first character cannot be a number or -, and the last character cannot end with -.
descriptionstringfalseOrganization's Description (Publicly Displayed)

Example​

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

Result 201​

{
  "error": false,
  "organization": {
    "type": "Organization",
    "name": "ExampleOrganization",
    "description": "This is Example Organization created via API",
    "url": "https://deploygate.com/organizations/ExampleOrganization"
  }
}

Result 400 - If Access With Organization's API Key​

{
  "error": true,
  "message": "requester must be a user",
  "because": "requester must be a user"
}
Last updated on