Apollo: Create Custom Field

Create a custom field in your Apollo CRM, such as a text, number, or picklist field.

Tool ID: apollo_create_custom_field

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(
  'apollo_create_custom_field',
  {
    "name": "Example",
    "field_type": "text"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute apollo_create_custom_field --input '{
  "name": "Example",
  "field_type": "text"
}' --json

Example response

The static output schema lacks the details for a reliable example. Use deepline describe apollo_create_custom_field --json for the complete live contract.

Input reference

Create a custom field in Apollo for contacts, accounts, or deals. Requires master API key.

Name	Type	Required	Default	Details
`payload.name`	`string`	Yes	—	Display name for the custom field.
`payload.field_type`	`"text" \| "long_text" \| "number" \| "date" \| "datetime" \| "picklist" \| "multi_picklist" \| "boolean" \| "url" \| "currency" \| "email" \| "phone"`	Yes	—	Custom field data type. Allowed: `text`, `long_text`, `number`, `date`, `datetime`, `picklist`, `multi_picklist`, `boolean`, `url`, `currency`, `email`, `phone`.
`payload.picklist_values`	`array`	No	—	Picklist option values. Required when field_type is picklist or multi_picklist.

Output reference

Apollo create custom field result.

Name	Type	Required	Default	Details
`result.data`	`record`	Yes	—	Payload with the created custom field object.
`result.meta`	`record`	No	—	Additional response metadata (status, paging).

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