dw_invite_user: Invite a person to a team

In munichrocker/DatawRappr: Provides Access to Datawrapper's API

Invite a person to a team

Description

\lifecycle

maturing

Usage

dw_invite_user(
  team,
  email,
  role = c("member", "admin", "owner"),
  api_key = "environment"
)

Arguments

team	Required. The team-id (can be found in the URL of a teams-folder) as character.
email	Required. The email-address that gets an invitation as character.
role	Required. Set to one of: member, admin, owner. Check this for more informations: How to invite others to a team
api_key	Optional. A Datawrapper-API-key as character string. Defaults to "environment" - tries to automatically retrieve the key that's stored in the .Reviron-file by datawrapper_auth.

Details

Invites a new team member.

Value

A message of failure or success, derived from the API's status code.

Note

This function invites a email-address to a team.

Author(s)

Benedict Witzenberger

Examples

## Not run: 
dw_invite_user(team = "testTeam", email = "test_at_test.com", role = "admin")

## End(Not run) # uses the preset key in the .Renviron-file

munichrocker/DatawRappr documentation built on Oct. 18, 2024, 2:46 p.m.