Amplemarket: Patch People Enrichment Requests ID

Cancel a running batch person enrichment in Amplemarket by its request ID.

Tool ID: amplemarket_patch_people_enrichment_requests_id

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

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

deepline tools execute amplemarket_patch_people_enrichment_requests_id --input '{
  "id": "id_123",
  "status": "canceled"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "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 describe 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`.

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.

This output schema is too large for an inline display. Read the complete live contract with deepline describe amplemarket_patch_people_enrichment_requests_id --json.

Deepline cost

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

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation