/organizations/{org_id}/invitationsCreate organization invitations
Creates invitations for a specific organization. If the invited user has an existing account, they automatically join as a member. If they don't yet have an account, they are invited to create one, after which they become a member. Each invited user receives an email notification.
Quick start
curl "https://console.neon.tech/api/v2/organizations/$ORG_ID/invitations" \
-X POST \
-H "Authorization: Bearer $NEON_API_KEY" \
-H "Content-Type: application/json" \
-d '{"invitations":[{"email":"invited-user@email.com","role":"member"}]}'import { createApiClient } from '@neondatabase/api-client';
const api = createApiClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await api.createOrganizationInvitations(process.env.ORG_ID, {
"invitations": [
{
"email": "invited-user@email.com",
"role": "member"
}
]
});Parameters
org_idThe Neon organization ID
Request body
2 required Required: invitations.email, invitations.role.
invitationsResponse
200The created organization invitation
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.