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

Response

The newly created invite

The response is of type object.