Invitations

The bitbucket 'invitations' REST resource allows repository administrators to send email invitations to grant read, write, or admin privileges to a repository.

Once the invitation receipt URL, provided in the email, is visited, that person is automatically granted the privileges specified by the invitation.

Sending an invitation

To send an invitation to grant write privileges to john@example.com for the repository roger/ramjet:

This will return a 200 status code on success with the response body containing details about the invitation:

Valid values for permission are:

• read (except for public repositories)
• write
• admin

Status Codes

200 OK

Returned when the invitation was successfully created and queued for sending. The response body will contain details of the invitation.

400 Bad Request

Returned when

• the repository (username and repository name combination, e.g., roger/ramjet) is not provided

• the email address is invalid

• the permission is not one of read, write, or admin, or read is supplied for a public repository

401 Unauthorized

Returned when you don't provide valid log in credentials when requesting the resource or you are not an administrator for the repository.

404 Not Found

Returned when the repository does not exist.

409 Conflict

Returned when the provided email address has already been invited to the repository.