Skip to main content
POST
/
orgs
/
{orgId}
/
invites
Invite a user to an organization
curl --request POST \
  --url https://api.withampersand.com/v1/orgs/{orgId}/invites \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "email": "alice@company.com"
}'
{
  "id": "<string>",
  "invitedEmail": "<string>",
  "parentType": "org",
  "parentId": "<string>",
  "status": "pending",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
orgId
string
required

ID of the organization.

Body

application/json
​
email
string
required

The email address of the user to invite.

Example:

"alice@company.com"

Response

The newly created invite

​
id
string
required

The invite ID.

​
invitedEmail
string
required

The email address of the person invited.

​
parentType
enum<string>
required

The type of entity that the person is invited to.

Available options:
org
​
parentId
string
required

The ID of the parent (e.g. org ID).

​
status
enum<string>
required

The status of the invite.

Available options:
pending,
accepted,
revoked,
expired
​
createTime
string<date-time>
required

The time the invite was created.

​
updateTime
string<date-time>

The time the invite was updated.

⌘I