summaryrefslogtreecommitdiff
path: root/doc/api/invitations.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/invitations.md')
-rw-r--r--doc/api/invitations.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/api/invitations.md b/doc/api/invitations.md
index fbdecd0e3fa..36ff2d5bda4 100644
--- a/doc/api/invitations.md
+++ b/doc/api/invitations.md
@@ -4,7 +4,7 @@ group: Expansion
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
-# Invitations API
+# Invitations API **(FREE)**
Use the Invitations API to send email to users you want to join a group or project, and to list pending
invitations.
@@ -41,10 +41,13 @@ POST /projects/:id/invitations
| `email` | string | yes | The email of the new member or multiple emails separated by commas |
| `access_level` | integer | yes | A valid access level |
| `expires_at` | string | no | A date string in the format YEAR-MONTH-DAY |
+| `invite_source` | string | no | The source of the invitation that starts the member creation process. See [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/327120). |
```shell
-curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "email=test@example.com&access_level=30" "https://gitlab.example.com/api/v4/groups/:id/invitations"
-curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "email=test@example.com&access_level=30" "https://gitlab.example.com/api/v4/projects/:id/invitations"
+curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
+ --data "email=test@example.com&access_level=30" "https://gitlab.example.com/api/v4/groups/:id/invitations"
+curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
+ --data "email=test@example.com&access_level=30" "https://gitlab.example.com/api/v4/projects/:id/invitations"
```
Example responses: