OMomnistack-sh
Invites

Create invite

Changed on

Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.

post/organization/invites

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/organization/invites
  • Auth
    HTTP bearer

Request body

emailstring required

Send an email to this address

role'reader' | 'owner' required

owner or reader

Response

User invited successfully.

object'organization.invite' required

The object type, which is always organization.invite

idstring required

The identifier, which can be referenced in API endpoints

emailstring required

The email address of the individual to whom the invite was sent

role'owner' | 'reader' required

owner or reader

status'accepted' | 'expired' | 'pending' required

accepted,expired, or pending

created_atinteger required

The Unix timestamp (in seconds) of when the invite was sent.

expires_atinteger nullable

The Unix timestamp (in seconds) of when the invite expires.

accepted_atinteger nullable

The Unix timestamp (in seconds) of when the invite was accepted.

Changes

  • 487892d3954eRevision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 7f654af7f94fRevision changes
    • breaking

      the response property became optional for the status

    • breaking

      response property accepted_at list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property expires_at list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      removed the required property from the response with the status

    • info

      the endpoint scheme security AdminApiKeyAuth was added to the API

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the success response with the status