Affinity: V2 Reminders Post - Deepline

Create a one-time or recurring Affinity reminder on a company, person or opportunity.

Tool ID: affinity_v2_reminders_post

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(
  'affinity_v2_reminders_post',
  {
    "owner": {
      "id": 123
    },
    "entity": {
      "type": "company",
      "id": 123
    },
    "type": "one-time"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute affinity_v2_reminders_post --input '{
  "owner": {
    "id": 123
  },
  "entity": {
    "type": "company",
    "id": 123
  },
  "type": "one-time"
}' --json

Example response

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

Input reference

Request body for creating a reminder. Discriminated by type — see reminders.OneTimeReminderToBeCreated and reminders.RecurringReminderToBeCreated. Exactly one of company, person, or opportunity must be provided.

Name	Type	Required	Default	Details
`payload.owner`	`object`	Yes	—	—
`payload.content`	`string`	No	—	Free-form text attached to the reminder.
`payload.entity`	`object`	Yes	—	The entity the reminder is attached to. Exactly one of `company`, `person`, or `opportunity` can be tagged on a reminder — the variant is selected by the `type` discriminator.
`payload.type`	`"one-time" \| "recurring"`	Yes	—	Allowed: `one-time`, `recurring`.
`payload.dueDate`	`string`	No	—	—
`payload.recurrence`	`object`	No	—	Recurrence configuration.

Output reference

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	—
`result.data.id`	`integer`	Yes	—	Format: `int64`. Minimum: 1. Maximum: 9007199254740991.
`result.data.content`	`string \| null`	Yes	—	—
`result.data.dueDate`	`string`	Yes	—	Format: `date-time`.
`result.data.creator`	`object`	Yes	—	—
`result.data.creator.id`	`integer`	Yes	—	Format: `int64`. Minimum: 1. Maximum: 9007199254740991.
`result.data.owner`	`object`	Yes	—	—
`result.data.owner.id`	`integer`	Yes	—	Format: `int64`. Minimum: 1. Maximum: 9007199254740991.
`result.data.completer`	`record`	Yes	—	—
`result.data.company`	`record`	Yes	—	—
`result.data.person`	`record`	Yes	—	—
`result.data.opportunity`	`record`	Yes	—	—
`result.data.createdAt`	`string`	Yes	—	Format: `date-time`.
`result.data.updatedAt`	`string \| null`	Yes	—	Format: `date-time`.
`result.data.type`	`"one-time" \| "recurring"`	Yes	—	Allowed: `one-time`, `recurring`.
`result.data.status`	`"active" \| "overdue" \| "completed" \| "active" \| "overdue"`	Yes	—	—
`result.data.completedAt`	`string \| null`	Yes	—	Format: `date-time`.
`result.data.recurrence`	`object \| null`	Yes	—	—
`result.data.recurrence.resetTrigger`	`"interaction" \| "email" \| "event"`	Yes	—	Allowed: `interaction`, `email`, `event`.
`result.data.recurrence.periodDays`	`integer`	Yes	—	Format: `int32`. Minimum: 1. Maximum: 2147483647.
`result.meta`	`object`	No	—	—

Deepline cost

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