reminders

Create Opportunity Reminder

Create a new reminder associated with an opportunity.

post/opportunities/{opportunity_id}/reminders

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/opportunities/{opportunity_id}/reminders
  • Auth: API key in header x-api-key

Path parameters

opportunity_idstring required

Request body

titlestring required

Reminder title

assigneeIdinteger required

ID of the user assigned to this reminder

descriptionstring

Optional description

dueDatestring date-time

ISO 8601 due date

isCompletedboolean

Whether the reminder is completed

type'CALL' | 'EMAIL' | 'IN_PERSON' | 'VIRTUAL' | 'DEADLINE' | 'OTHER'

Reminder type

Response

Reminder created successfully

idinteger
titlestring
descriptionstring nullable
type'CALL' | 'EMAIL' | 'IN_PERSON' | 'VIRTUAL' | 'DEADLINE' | 'OTHER'
dueDatestring date-time nullable
isCompletedboolean
completedAtstring date-time nullable
assigneeIdinteger nullable
projectIdinteger nullable

Present when the reminder belongs to a project.

opportunityIdinteger nullable

Present when the reminder belongs to an opportunity.

accountIdinteger nullable

Present when the reminder belongs to an account.

createdByinteger nullable
createdAtstring date-time
updatedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.