enhancements_put_geocode_archive: Update the archive status of this object

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

Update the archive status of this object

Description

Update the archive status of this object

Usage

enhancements_put_geocode_archive(id, status)

Arguments

id	integer required. The ID of the object.
status	boolean required. The desired archived status of the object.

Value

A list containing the following elements:

id	integer, The ID for the enhancement.
name	string, The name of the enhancement job.
type	string, The type of the enhancement (e.g CASS-NCOA)
createdAt	string, The time this enhancement was created.
updatedAt	string, The time the enhancement was last updated.
author	list, A list containing the following elements: id integer, The ID of this user. name string, This user's name. username string, This user's username. initials string, This user's initials. online boolean, Whether this user is online.
state	string, The status of the enhancement's last run
schedule	list, A list containing the following elements: scheduled boolean, If the item is scheduled. scheduledDays array, Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth scheduledHours array, Hours of the day it is scheduled on. scheduledMinutes array, Minutes of the day it is scheduled on. scheduledRunsPerHour integer, Deprecated in favor of scheduled minutes. scheduledDaysOfMonth array, Days of the month it is scheduled on, mutually exclusive with scheduledDays.
notifications	list, A list containing the following elements: urls array, URLs to receive a POST request at job completion successEmailSubject string, Custom subject line for success e-mail. successEmailBody string, Custom body text for success e-mail, written in Markdown. successEmailAddresses array, Addresses to notify by e-mail when the job completes successfully. successEmailFromName string, Name from which success emails are sent; defaults to "Civis." successEmailReplyTo string, Address for replies to success emails; defaults to the author of the job. failureEmailAddresses array, Addresses to notify by e-mail when the job fails. stallWarningMinutes integer, Stall warning emails will be sent after this amount of minutes. successOn boolean, If success email notifications are on. Defaults to user's preferences. failureOn boolean, If failure email notifications are on. Defaults to user's preferences.
runningAs	list, A list containing the following elements: id integer, The ID of this user. name string, This user's name. username string, This user's username. initials string, This user's initials. online boolean, Whether this user is online.
myPermissionLevel	string, Your permission level on the object. One of "read", "write", or "manage".
remoteHostId	integer, The ID of the remote host.
credentialId	integer, The ID of the remote host credential.
sourceSchemaAndTable	string, The source database schema and table.
multipartKey	array, The source table primary key.
limitingSQL	string, The limiting SQL for the source table. "WHERE" should be omitted (e.g. state='IL').
targetSchema	string, The output table schema.
targetTable	string, The output table name.
country	string, The country of the addresses to be geocoded; either 'us' or 'ca'.
provider	string, The geocoding provider; one of postgis and geocoder_ca.
outputAddress	boolean, Whether to output the parsed address. Only guaranteed for the 'postgis' provider.
archived	string, The archival status of the requested item(s).
parentId	integer, Parent ID that triggers this enhancement.

civis documentation built on Aug. 30, 2025, 1:08 a.m.