OpenAI API (unofficial showcase)
POST/organization/invites

Create invite

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

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields

The invite request payload.

emailstringrequired
Send an email to this address
rolestringrequired
`owner` or `reader`
Allowed:readerowner
projectsarray<object>optional
An array of projects to which membership is granted at the same time the org invite is accepted. If omitted, the user will be invited to the default project for compatibility with legacy behavior. If empty list is passed, the user will not be invited to any projects, including the default one.

5 status codes
200User invited successfully.
objectstringrequired
The object type, which is always `organization.invite`
Allowed:organization.invite
idstringrequired
The identifier, which can be referenced in API endpoints
emailstringrequired
The email address of the individual to whom the invite was sent
rolestringrequired
`owner` or `reader`
Allowed:ownerreader
statusstringrequired
`accepted`,`expired`, or `pending`
Allowed:acceptedexpiredpending
created_atintegerrequired
The Unix timestamp (in seconds) of when the invite was sent.
expires_atintegeroptional
The Unix timestamp (in seconds) of when the invite expires.
accepted_atintegeroptional
The Unix timestamp (in seconds) of when the invite was accepted.
projectsarray<object>required
The projects that were granted membership upon acceptance of the invite.
201User invited successfully.
objectstringrequired
The object type, which is always `organization.invite`
Allowed:organization.invite
idstringrequired
The identifier, which can be referenced in API endpoints
emailstringrequired
The email address of the individual to whom the invite was sent
rolestringrequired
`owner` or `reader`
Allowed:ownerreader
statusstringrequired
`accepted`,`expired`, or `pending`
Allowed:acceptedexpiredpending
created_atintegerrequired
The Unix timestamp (in seconds) of when the invite was sent.
expires_atintegeroptional
The Unix timestamp (in seconds) of when the invite expires.
accepted_atintegeroptional
The Unix timestamp (in seconds) of when the invite was accepted.
projectsarray<object>required
The projects that were granted membership upon acceptance of the invite.
400The invite request is invalid or the user has already joined or been invited.
errorobjectrequired
403The caller does not have permission to perform this operation.
errorobjectrequired
Details about the permission error.
429Too many management requests. Reduce the request rate and try again later.
errorobjectrequired

Error handling

A 400 is returned: The invite request is invalid or the user has already joined or been invited. A 403 is returned: The caller does not have permission to perform this operation. A 429 is returned: Too many management requests. Reduce the request rate and try again later.