client.aliases.patch

A method of the Aliases endpoint.

patch(id: int, *, object_id: int = None, object_type: str = None, alias: str = None, display_name: str = None) → Response

Update some attributes of this Alias

API URL: PATCH /aliases/{id}

import civis
client = civis.APIClient()
response = client.aliases.patch(...)

Parameters:

idint

The id of the Alias object.

object_idint, optional

The id of the object

object_typestr, optional

The type of the object. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.

aliasstr, optional

The alias of the object

display_namestr, optional

The display name of the Alias object. Defaults to object name if not provided.

Returns:

civis.Response

• idint

  The id of the Alias object.

• object_idint

  The id of the object

• object_typestr

  The type of the object. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.

• aliasstr

  The alias of the object

• user_idint

  The id of the user who created the alias

• display_namestr

  The display name of the Alias object. Defaults to object name if not provided.