AFaffinity
Reminders

Create a Reminder

Changed on

Creates a new Reminder. Exactly one of company, person, or opportunity must be provided.

The creator of the new reminder is the user associated with the API key.

post/v2/reminders

Request

  • Base URL
    https://api.affinity.co
  • URL
    https://api.affinity.co/v2/reminders
  • Auth
    HTTP bearer

Request body

OR

Example request

{
  "owner": {
    "id": 1
  },
  "content": "Follow up about the funding round",
  "entity": {
    "type": "company",
    "id": 1
  }
}

Response

Created

OR

Example response

{
  "id": 1,
  "content": "Follow up about the funding round",
  "dueDate": "2026-06-01T17:00:00Z",
  "creator": {
    "id": 1
  },
  "owner": {
    "id": 1
  },
  "completer": {
    "id": 1
  },
  "company": {
    "id": 1
  },
  "person": {
    "id": 1
  },
  "opportunity": {
    "id": 1
  },
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-01T00:00:00Z"
}

Changes

  • 187749f77548Revision changes
    • info

      added one-time recurring mapping keys to the request discriminator

    • info

      added company person opportunity discriminator mapping keys to the // request property

    • info

      added company person opportunity discriminator mapping keys to the // request property

    • info

      added one-time recurring mapping keys to the response discriminator for the response status

    • info

      added authentication authorization bad-request conflict method-not-allowed not-acceptable not-found not-implemented rate-limit server timeout unprocessable-entity unsupported-media-type validation discriminator mapping keys to the / response property for the response status

    • info

      added bad-request validation discriminator mapping keys to the / response property for the response status