Create Opportunity Appointment

const url = 'https://api.coperniq.io/v1/opportunities/opportunityId/appointments';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"title":"string","assigneeId":1,"dueDate":"2024-01-15T09:30:00Z"}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": 1,
  "title": "string",
  "description": "string",
  "dueDate": "2024-01-15T09:30:00Z",
  "isCompleted": true,
  "completedAt": "2024-01-15T09:30:00Z",
  "assigneeId": 1,
  "opportunityId": 1,
  "createdBy": 1,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z"
}

Create a new appointment associated with an opportunity.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

opportunityIdstringRequired

Request

This endpoint expects an object.

titlestringRequired>=1 character

Appointment title

assigneeIdintegerRequired

ID of the user assigned to this appointment

dueDatestringRequiredformat: "date-time"

ISO 8601 scheduled date/time

descriptionstringOptional

Optional description

Response

Appointment created successfully

idinteger

titlestring

descriptionstring or null

dueDatestring or nullformat: "date-time"

isCompletedboolean

completedAtstring or nullformat: "date-time"

assigneeIdinteger or null

opportunityIdinteger or null

ID of the parent opportunity.

createdByinteger or null

createdAtstringformat: "date-time"

updatedAtstringformat: "date-time"

Errors

400

Bad Request Error

401

Unauthorized Error