Skip to main content
POST
/
workspaces
/
{workspaceSlug}
/
invites
Invite a developer to a workspace
curl --request POST \
  --url https://global.thenile.dev/workspaces/{workspaceSlug}/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "programmatic": true
}
'
{
  "id": "<string>",
  "sender": {
    "id": "<string>",
    "email": "<string>",
    "workspaces": [
      {
        "name": "<string>",
        "slug": "<string>",
        "id": "<string>",
        "stripe_customer_id": "<string>",
        "created": "2023-11-07T05:31:56Z"
      }
    ],
    "databases": [
      "<string>"
    ],
    "kind": "HUMAN"
  },
  "email": "<string>",
  "workspace": {
    "name": "<string>",
    "slug": "<string>",
    "id": "<string>",
    "stripe_customer_id": "<string>",
    "created": "2023-11-07T05:31:56Z"
  },
  "verificationState": "EMAIL_PENDING",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workspaceSlug
string
required

Body

application/json

Contact information for the invitee

Parameters for creating an invitation for a developer to join a workspace.

​
email
string<email>
required

The invitee's email address

​
programmatic
boolean

If true, the response will include the invite code.

Response

Invite created successfully. An email will be sent.

​
id
string
required
​
sender
object
required
​
email
string
required
​
workspace
object
required
​
verificationState
enum<string>
required
Available options:
EMAIL_PENDING,
EMAIL_SENT,
VERIFIED,
EXPIRED
​
created
string<date-time>
​
updated
string<date-time>