PUT group/…/members/…

Adds a user to a group.

This user can be an existing Drillster user, or somebody who does not yet have a Drillster account in which case an account will be created on the fly. If the user is successfully added, they will receive a notification by email.

Resource URL

https://www.drillster.com/api/2.1.1/group/{group_id}/members/{user_id}

or

https://www.drillster.com/api/2.1.1/group/{group_id}/members/{user_email}

The group ID is the unique identifier for the group.

To identify the invited user, the user ID can be specified (if the user is an existing Drillster user, and the user ID is known), or the email address. The email address can be used for users with or without a Drillster account. If the user already has a Drillster account, the email address must be one of the email addresses configured in the account's profile. Alternatively, a supported third party ID may be specified.

Parameters

💡 Good to know

The parameters must be appended to the URL, and not be included in the message body. For example: /api/2.1.1/group/0kIpT-yh7l6dF0w4EWkRYaB-0wzeHAJzM6vlL1te6wI/members/john.doe@drillster.com?setup=true&name=John+Doe

If a PUT request has no body (i.e. the body is empty), it is still mandatory to include a Content-Length header (i.e. Content-Length: 0). Not all HTTP clients do this automatically. For more information, please see RFC 2616.

Response

A 2.1.1 OK object containing a message stating that the user has successfully been invited.

Example request

PUT https://www.drillster.com/api/2.1.1/group/0kIpT-yh7l6dF0w4EWkRYaB-0wzeHAJzM6vlL1te6wI/members/john.doe@drillster.com

Response

{
  "description": "The user has been invited to the group."
}

Error responses

The following error situations are possible: