> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Amplemarket: Patch People Enrichment Requests ID

> Cancel batch of person enrichments. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Cancel batch of person enrichments.

<Info>
  Tool ID: `amplemarket_patch_people_enrichment_requests_id`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'amplemarket_patch_people_enrichment_requests_id',
  {
    "id": "id_123",
    "status": "canceled"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute amplemarket_patch_people_enrichment_requests_id --input '{
  "id": "id_123",
  "status": "canceled"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "id": 123,
    "object": "person_enrichment",
    "status": "queued",
    "results": [
      {
        "id": 123,
        "status": "enriched",
        "result": {
          "id": "123e4567-e89b-42d3-a456-426614174000",
          "object": "person",
          "linkedin_url": "https://www.linkedin.com/in/jane-doe"
        }
      }
    ],
    "_links": {
      "self": {
        "href": "example"
      }
    }
  }
}
```

Use `deepline tools get amplemarket_patch_people_enrichment_requests_id --json` for the latest machine-readable contract.

## Input reference

Cancel batch of person enrichments

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | Batch id |
| `payload.page` | `object` | No | — | Page size. Accepts an integer or a numeric string; Amplemarket types this field inconsistently across operations. |
| `payload.status` | `"canceled"` | Yes | — | Allowed: `canceled`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Cancel batch of person enrichments",
    "properties": {
      "id": {
        "type": "string",
        "description": "Batch id"
      },
      "page": {
        "type": "object",
        "description": "Page size. Accepts an integer or a numeric string; Amplemarket types this field inconsistently across operations.",
        "properties": {
          "size": {
            "type": [
              "integer",
              "string"
            ],
            "description": "Page size. Accepts an integer or a numeric string; Amplemarket types this field inconsistently across operations."
          },
          "after": {
            "type": "string",
            "description": "Page after"
          },
          "before": {
            "type": "string",
            "description": "Page before"
          }
        },
        "required": [],
        "additionalProperties": false
      },
      "status": {
        "type": "string",
        "enum": [
          "canceled"
        ]
      }
    },
    "required": [
      "id",
      "status"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.id` | `integer` | Yes | — | — |
| `result.data.object` | `"person_enrichment"` | Yes | — | Allowed: `person_enrichment`. |
| `result.data.status` | `"queued" \| "processing" \| "completed" \| "canceled" \| "error"` | Yes | — | Allowed: `queued`, `processing`, `completed`, `canceled`, `error`. |
| `result.data.results` | `array` | Yes | — | — |
| `result.data.results[].id` | `integer` | No | — | — |
| `result.data.results[].status` | `"enriched" \| "not_found" \| "gdpr_removed"` | No | — | Allowed: `enriched`, `not_found`, `gdpr_removed`. |
| `result.data.results[].result` | `object` | No | — | — |
| `result.data.results[].result.id` | `string` | Yes | — | Format: `uuid`. |
| `result.data.results[].result.object` | `"person"` | Yes | — | Allowed: `person`. |
| `result.data.results[].result.linkedin_url` | `string` | Yes | — | — |
| `result.data.results[].result.name` | `string \| null` | No | — | — |
| `result.data.results[].result.email` | `string \| null` | No | — | — |
| `result.data.results[].result.first_name` | `string \| null` | No | — | — |
| `result.data.results[].result.last_name` | `string \| null` | No | — | — |
| `result.data.results[].result.title` | `string \| null` | No | — | — |
| `result.data.results[].result.headline` | `string \| null` | No | — | — |
| `result.data.results[].result.about` | `string \| null` | No | — | — |
| `result.data.results[].result.current_position_start_date` | `string \| null` | No | — | Format: `date`. |
| `result.data.results[].result.current_position_description` | `string \| null` | No | — | — |
| `result.data.results[].result.location` | `string \| null` | No | — | — |
| `result.data.results[].result.image_url` | `string` | No | — | Format: `uri`. |
| `result.data.results[].result.gender` | `"male" \| "female" \| "likely_male" \| "likely_female" \| "unknown"` | No | — | Allowed: `male`, `female`, `likely_male`, `likely_female`, `unknown`. |
| `result.data.results[].result.location_details` | `object` | No | — | — |
| `result.data.results[].result.location_details.country` | `string \| null` | No | — | — |
| `result.data.results[].result.location_details.state` | `string \| null` | No | — | — |
| `result.data.results[].result.location_details.city` | `string \| null` | No | — | — |
| `result.data.results[].result.location_details.postal_code` | `string \| null` | No | — | — |
| `result.data.results[].result.location_details.lat` | `number \| null` | No | — | — |
| `result.data.results[].result.location_details.long` | `number \| null` | No | — | — |
| `result.data.results[].result.experiences` | `array \| null` | No | — | — |
| `result.data.results[].result.experiences[].object` | `"experience"` | Yes | — | Allowed: `experience`. |
| `result.data.results[].result.experiences[].title` | `string` | Yes | — | — |
| `result.data.results[].result.experiences[].company_name` | `string` | Yes | — | — |
| `result.data.results[].result.experiences[].company_linkedin_url` | `string \| null` | Yes | — | Format: `uri`. |
| `result.data.results[].result.experiences[].description` | `string \| null` | Yes | — | — |
| `result.data.results[].result.experiences[].start_date` | `string \| null` | Yes | — | Format: `date`. |
| `result.data.results[].result.experiences[].end_date` | `string \| null` | Yes | — | Format: `date`. |
| `result.data.results[].result.educations` | `array \| null` | No | — | — |
| `result.data.results[].result.educations[].object` | `"education"` | Yes | — | Allowed: `education`. |
| `result.data.results[].result.educations[].degree` | `string \| null` | Yes | — | — |
| `result.data.results[].result.educations[].field_of_study` | `string \| null` | Yes | — | — |
| `result.data.results[].result.educations[].school_name` | `string` | Yes | — | — |
| `result.data.results[].result.educations[].school_linkedin_url` | `string \| null` | Yes | — | Format: `uri`. |
| `result.data.results[].result.educations[].start_date` | `string \| null` | Yes | — | Format: `date`. |
| `result.data.results[].result.educations[].end_date` | `string \| null` | Yes | — | Format: `date`. |
| `result.data.results[].result.languages` | `array \| null` | No | — | — |
| `result.data.results[].result.languages[].object` | `"language"` | Yes | — | Allowed: `language`. |
| `result.data.results[].result.languages[].language` | `string` | Yes | — | — |
| `result.data.results[].result.languages[].iso_code` | `string` | Yes | — | — |

The table shows the first 50 fields. Expand the raw schema below for every field.

<Info>
  This output schema is too large to embed without slowing the page. Get the complete live contract with `deepline tools get amplemarket_patch_people_enrichment_requests_id --json`.
</Info>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Amplemarket provider guide](/docs/providers/amplemarket/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.