client.jobs.put_transfer

A method of the Jobs endpoint.

put_transfer(id: int, user_id: int, include_dependencies: bool, *, email_body: str = None, send_email: bool = None) → Response

Transfer ownership of this object to another user

API URL: PUT /jobs/{id}/transfer

import civis
client = civis.APIClient()
response = client.jobs.put_transfer(...)

Parameters:

idint

The ID of the resource that is shared.

user_idint

ID of target user

include_dependenciesbool

Whether or not to give manage permissions on all dependencies

email_bodystr, optional

Custom body text for e-mail sent on transfer.

send_emailbool, optional

Send email to the target user of the transfer?

Returns:

civis.Response

• dependenciesList[civis.Response]

  Dependent objects for this object

  • object_typestr

    Dependent object type

  • fco_typestr

    Human readable dependent object type

  • idint

    Dependent object ID

  • namestr

    Dependent object name, or nil if the requesting user cannot read this object

  • permission_levelstr

    Permission level of target user (not user’s groups) for dependent object. Null if no target user or not shareable (e.g. a database table).

  • descriptionstr

    Additional information about the dependency, if relevant

  • sharedbool

    Whether dependent object was successfully shared with target user