Create Opportunity Appointment

POST

https://api.coperniq.io/v1/opportunities/:opportunity_id/appointments

POST

/v1/opportunities/:opportunity_id/appointments

1 const url = 'https://api.coperniq.io/v1/opportunities/opportunity_id/appointments';
2 const options = {
3   method: 'POST',
4   headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5   body: '{"title":"string","assigneeId":1,"dueDate":"2024-01-15T09:30:00Z"}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "id": 1,
3   "title": "string",
4   "description": "string",
5   "dueDate": "2024-01-15T09:30:00Z",
6   "isCompleted": true,
7   "completedAt": "2024-01-15T09:30:00Z",
8   "assigneeId": 1,
9   "opportunityId": 1,
10   "createdBy": 1,
11   "createdAt": "2024-01-15T09:30:00Z",
12   "updatedAt": "2024-01-15T09:30:00Z"
13 }

Create a new appointment associated with an opportunity.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

opportunity_idstringRequired

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

idintegerOptional

titlestringOptional

descriptionstring or nullOptional

dueDatestring or nullOptionalformat: "date-time"

isCompletedbooleanOptional

completedAtstring or nullOptionalformat: "date-time"

assigneeIdinteger or nullOptional

opportunityIdinteger or nullOptional

ID of the parent opportunity.

createdByinteger or nullOptional

createdAtstringOptionalformat: "date-time"

updatedAtstringOptionalformat: "date-time"

Errors

400

Bad Request Error

401

Unauthorized Error