IOionworks

Invite a user to a project by email

Changed on

Invite someone to a project by email, whatever their organization status.

Unlike POST /{project_id}/members, the invitee need not already belong to the organization: an unregistered email is invited, and a non-member is granted Member. An existing member keeps the organization role they already hold.

Requires role:assign, not merely project:manage_members — minting an organization membership is an org-level grant however project-shaped the request looks.

Returns

AddUserByEmailResult The invitee's user id, and invite_sent — False when the address already belonged to a registered account, so no email was dispatched.

post/projects/{project_id}/invites

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/projects/{project_id}/invites
  • Auth
    none declared

Path parameters

project_idstring uuid required

Request body

emailstring required

Email address of the person to invite.

project_role_idstring required

ID of the project role to assign.

Response

Successful Response

user_idstring required

ID of the (invited or pre-existing) user that was added.

invite_sentboolean required

True when the email was not registered yet and an invitation email was dispatched. False when the email already belonged to a registered user, in which case the existing account was linked and no email was sent.

already_memberboolean

True when the user already belonged to the organization. Their membership, including its role, was left unchanged.

role_namestring nullable

Organization role the user holds after the request, when the endpoint reports it.

Changes

  • ea3d377fec1aRevision changes
    • breaking

      for the path request parameter project_id, the format changed from no format to uuid

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 6ee5ca7926deRevision changes
    • info

      endpoint added