Skip to content

Commit f1f3743

Browse files
author
Linh Nguyen
committed
Update after review
1 parent 26bcfe1 commit f1f3743

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

help/hygiene/api/workorder.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ The following table describes the properties in the response.
299299

300300
To create a record delete work order from CSV, TSV, or TXT files containing identifiers, you can use conversion scripts to produce the required JSON payloads for the `/workorder` endpoint. This approach is especially helpful when working with existing data files. For ready-to-use scripts and comprehensive instructions, visit the [csv-to-data-hygiene GitHub repository](https://github.com/perlmonger42/csv-to-data-hygiene).
301301

302-
**Generate JSON payloads**
302+
### Generate JSON payloads
303303

304304
The following bash script examples demonstrate how to run the conversion scripts in Python or Ruby:
305305

@@ -352,13 +352,13 @@ The table below describes the parameters in the bash scripts.
352352
| `verbose` | Enable verbose output. |
353353
| `column` | The index (1-based) or header name of the column containing the identity values to delete. Defaults to the first column if not specified. |
354354
| `namespace` | An object with a `code` property specifying the identity namespace (for example, "email"). |
355-
| `dataset-id` | The unique identifier for the dataset associated with the work order. If the request applies to all datasets, this field will be set to ALL. |
355+
| `dataset-id` | The unique identifier for the dataset associated with the work order. If the request applies to all datasets, this field will be set to `ALL`. |
356356
| `description` | A description of the record delete work order. |
357357
| `output-dir` | The directory to write the output JSON payload. |
358358

359359
{style="table-layout:auto"}
360360

361-
A successful JSON payload converted from CSV, TSV, or TXT files contains the records associated with the specified namespace, for example email address.
361+
The example below shows a successful JSON payload converted from a CSV, TSV, or TXT file. It contains records associated with the specified namespace and is used to delete records identified by email addresses.
362362

363363
```json
364364
{
@@ -395,9 +395,9 @@ The following table describes the properties in the JSON payload.
395395

396396
{style="table-layout:auto"}
397397

398-
**Submit the generated JSON data to the `/workorder` endpoint**
398+
### Submit the generated JSON data to the `/workorder` endpoint
399399

400-
For submission, please follow the guideline in the [create a record delete work order](#create) section. Make sure to use the converted JSON payload as the `-d` value when sending your `curl` POST request to the `/workorder` API endpoint.
400+
To submit a request, follow the instructions in the [create a record delete work order](#create) section. Make sure to use the converted JSON payload as the request body (`-d`) when sending your `curl` POST request to the `/workorder` API endpoint.
401401

402402
## Retrieve details for a specific record delete work order {#lookup}
403403

0 commit comments

Comments
 (0)