iam

Invite one or more users to an organization

post/orgs/{org_id}/iam/users

Path parameters

org_idstring required

Request body

emailstring nullable

Single email address to invite. Legacy shape — prefer emails. Merged with emails when both are provided.

emailsstring[] nullable

Email addresses to invite to the organization.

send_emailboolean

Whether to send an invitation email to each invitee. Defaults to true.

Response

User invited successfully

Changes

Changed in 3 of the 51 revisions of this API.14

    • added the new optional request property email

      new-optional-request-property

    • the request property emails became nullable

      request-property-became-nullable

    • the request property emails became optional

      request-property-became-optional

    This revision also has 22 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 238 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog