PEpermit
Invites

Invite Members To Organization

Changed on

Invite new members into the organization.

post/v2/orgs/{org_id}/invites

Request

  • Base URL
    https://api.permit.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

org_idstring required

Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the "slug").

Query parameters

inviter_namestring
inviter_emailstring

Request body

member_idstring uuid

Unique id of the invite

emailstring email required

The invited member's email address

role'admin' | 'write' | 'read' | 'no_access'

An enumeration.

Response

Successful Response

Example response

{
  "success": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "invite_code": "40ef0e48-a11f-4963-a229-e396c9eeefff",
      "email": "jane@coolcompany.com",
      "role": "admin",
      "created_at": "2019-08-24T14:15:22Z",
      "status": "pending",
      "failed_reason": ""
    }
  ]
}

Changes