Add Member to Organization

This page contains information intended for the Discontinued Organization Plans.

If you are using Flexible/Enterprise plan, please visit this page.

POST https://deploygate.com/api/organizations/{ORGANIZATION_NAME}/members

Add new users to the Organization as members. If the user has not registered with DeployGate, an invitation will be sent.

---

Path Params

Name	Type	Required	Description
ORGANIZATION_NAME	string	true	Organization Name

Body

Name	Type	Required	Description
username	string	false	DeployGate username
email	string	false	Email address registered with DeployGate, or the email address to which an invitation will be sent

Parameters in request body

When inviting a user, provide either username or email as a query parameter.

• When username is specified, the DeployGate user whose username matches the specified value will be added as a member.
• When email is specified
  • If the email address is already registered to a DeployGate user, that user will be added.
  • If the email address is not yet registered, an invitation email will be sent to the specified email address. Follow the instructions in the invitation email to sign up, and once registration is complete, you will be automatically added to the group that invited you.

Example

curl \
  -X POST \
  --url "https://deploygate.com/api/organizations/${ORGANIZATION_NAME}/members" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${API_TOKEN}" \
  --form-string "email=${EMAIL}"

Result 200

{
  "error": false,
  "message": "${EMAIL} was invited to ${ORGANIZATION_NAME}"
}

Result 400

{}