Clear

NOTICE: At the current time, this API call is ONLY compatible with places-v3. Please see the the migration page for more details.

Introduction

Clear allows you to clear one or more attributes from a Factual record.

Syntax

Calls to Clear require a factual ID to indicate the row, a user and the fields which should be cleared.

Parameter	Description	Required?	Example
user	An arbitrary token representing the end user who is submitting the data.	Yes	user = "my_username"
fields	The attribute fields to be cleared.	Yes	fields = ["longitude"]
factual ID	The ID of the entry to be cleared	Yes	factualId = "f33527e0-a8b4-4808-a820-2686f18cb00c"

Simple Clear Example

let write = Clear { table = Custom "2EH4Pz"
                  , factualId = "f33527e0-a8b4-4808-a820-2686f18cb00c"
                  , user = "testUser"
                  , fields = ["country"] }
reply <- executeWrite options write