Clerk Android API/com.clerk.api.network.api/OrganizationApi/bulkCreateInvitations

bulkCreateInvitations

@FormUrlEncoded

@POST(value = "organizations/{organization_id}/invitations/bulk")

abstract suspend fun bulkCreateInvitations(@Path(value = "organization_id") organizationId: String, @Field(value = "email_address") emailAddresses: List<String>, @Field(value = "role") role: String): ClerkResult<List<OrganizationInvitation>, ClerkErrorResponse>

Bulk create an invitation for a user to join an organization.

The current user must have permissions to manage the members of the organization.

Parameters

organizationId

The id of the organization for which the invitations will be created.

emailAddresses

An array of email addresses the invitations will be sent to.

role

The role that will be assigned to each of the users after joining. This can be one of the predefined roles (org:admin, org:basic_member) or a custom role.