> ## 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 Companies Enrichment Requests ID

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

Cancel batch of company enrichments.

<Info>
  Tool ID: `amplemarket_patch_companies_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_companies_enrichment_requests_id',
  {
    "id": "id_123",
    "status": "canceled"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute amplemarket_patch_companies_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": "company_enrichment",
    "status": "queued",
    "results": [
      {
        "id": 123,
        "status": "found",
        "result": {
          "id": "123e4567-e89b-42d3-a456-426614174000",
          "object": "company",
          "linkedin_url": "https://www.linkedin.com/in/jane-doe"
        }
      }
    ],
    "_links": {
      "self": {
        "href": "example"
      }
    }
  }
}
```

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

## Input reference

Cancel batch of company 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 company 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` | `"company_enrichment"` | Yes | — | Allowed: `company_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` | `"found" \| "not_found" \| "pending"` | No | — | Allowed: `found`, `not_found`, `pending`. |
| `result.data.results[].result` | `object` | No | — | — |
| `result.data.results[].result.id` | `string` | Yes | — | Format: `uuid`. |
| `result.data.results[].result.object` | `"company"` | Yes | — | Allowed: `company`. |
| `result.data.results[].result.linkedin_url` | `string` | Yes | — | — |
| `result.data.results[].result.name` | `string \| null` | No | — | — |
| `result.data.results[].result.overview` | `string \| null` | No | — | — |
| `result.data.results[].result.website` | `string \| null` | No | — | — |
| `result.data.results[].result.keywords` | `array \| null` | No | — | — |
| `result.data.results[].result.followers` | `integer \| null` | No | — | — |
| `result.data.results[].result.linkedin_presence` | `"massive" \| "large" \| "moderate" \| "limited" \| "none"` | No | — | `massive` — Massive following (100,000+ followers), `large` — Large following (10,000 - 99,999 followers), `moderate` — Moderate following (1,000 - 9,999 followers), `limited` — Limited following (1 - 999 followers), `none` — No following (0 followers). All ranges are inclusive. Allowed: `massive`, `large`, `moderate`, `limited`, `none`. |
| `result.data.results[].result.estimated_number_of_employees` | `integer \| null` | No | — | — |
| `result.data.results[].result.size` | `"10001+ employees" \| "201-500 employees" \| "51-200 employees" \| "11-50 employees" \| "1-10 employees"` | No | — | Allowed: `10001+ employees`, `201-500 employees`, `51-200 employees`, `11-50 employees`, `1-10 employees`. |
| `result.data.results[].result.location` | `string \| null` | No | — | — |
| `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.locations` | `array \| null` | No | — | — |
| `result.data.results[].result.locations[].address` | `string` | No | — | Full address as a single string |
| `result.data.results[].result.locations[].is_primary` | `boolean` | No | — | Indicates if this is the primary location |
| `result.data.results[].result.locations[].country` | `string \| null` | No | — | Country name (e.g., United States) |
| `result.data.results[].result.locations[].state` | `string \| null` | No | — | State or subdivision name (e.g., California, New York) |
| `result.data.results[].result.locations[].city` | `string \| null` | No | — | City name |
| `result.data.results[].result.locations[].postal_code` | `string \| null` | No | — | Postal code |
| `result.data.results[].result.logo_url` | `string` | No | — | Format: `uri`. |
| `result.data.results[].result.founded_year` | `integer \| null` | No | — | — |
| `result.data.results[].result.traffic_rank` | `integer \| null` | No | — | — |
| `result.data.results[].result.sic_codes` | `array \| null` | No | — | — |
| `result.data.results[].result.naics_codes` | `array \| null` | No | — | — |
| `result.data.results[].result.type` | `"Public Company" \| "Educational" \| "Self Employed" \| "Government Agency" \| "Non Profit" \| "Self Owned" \| "Privately Held" \| "Partnership"` | No | — | Allowed: `Public Company`, `Educational`, `Self Employed`, `Government Agency`, `Non Profit`, `Self Owned`, `Privately Held`, `Partnership`. |
| `result.data.results[].result.total_funding` | `integer \| null` | No | — | — |
| `result.data.results[].result.latest_funding_stage` | `"seed" \| "angel" \| "venture_round_unknown_series" \| "series_a" \| "series_b" \| "series_c" \| "series_d" \| "series_e" \| "series_f" \| "series_g" \| "series_h" \| "series_i" \| "series_j" \| "debt" \| "equity_crowdfunding" \| "convertible_note" \| "ico" \| "private_equity" \| "other"` | No | — | Allowed: `seed`, `angel`, `venture_round_unknown_series`, `series_a`, `series_b`, `series_c`, `series_d`, `series_e`, `series_f`, `series_g`, `series_h`, `series_i`, `series_j`, `debt`, `equity_crowdfunding`, `convertible_note`, `ico`, `private_equity`, `other`. |
| `result.data.results[].result.latest_funding_date` | `string \| null` | No | — | Format: `date`. |
| `result.data.results[].result.is_b2b` | `boolean \| null` | No | — | — |
| `result.data.results[].result.is_b2c` | `boolean \| null` | No | — | — |
| `result.data.results[].result.technologies` | `array \| null` | No | — | — |
| `result.data.results[].result.department_headcount` | `record` | No | — | — |
| `result.data.results[].result.job_function_headcount` | `record` | No | — | — |
| `result.data.results[].result.estimated_revenue` | `"$0-$1M" \| "$1M-$10M" \| "$10M-$100M" \| "$100M-$1B" \| "$1B+"` | No | — | Allowed: `$0-$1M`, `$1M-$10M`, `$10M-$100M`, `$100M-$1B`, `$1B+`. |
| `result.data.results[].result.revenue` | `integer \| null` | No | — | — |

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_companies_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.