aliases_put_transfer: Transfer ownership of this object to another user

In civis: R Client for the 'Civis Platform API'

Transfer ownership of this object to another user

Description

Transfer ownership of this object to another user

Usage

aliases_put_transfer(
  id,
  user_id,
  include_dependencies,
  email_body = NULL,
  send_email = NULL
)

Arguments

id	integer required. The ID of the resource that is shared.
user_id	integer required. ID of target user
include_dependencies	boolean required. Whether or not to give manage permissions on all dependencies
email_body	string optional. Custom body text for e-mail sent on transfer.
send_email	boolean optional. Send email to the target user of the transfer?

Value

A list containing the following elements:

dependencies

array, An array containing the following fields: objectType string, Dependent object type fcoType string, Human readable dependent object type id integer, Dependent object ID name string, Dependent object name, or nil if the requesting user cannot read this object permissionLevel string, Permission level of target user (not user's groups) for dependent object, or null if no target user shared boolean, Whether dependent object was successfully shared with target user

civis documentation built on April 1, 2023, 12:01 a.m.