The Opportunity Lost Reason object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

lost_reason string
The Opportunity Lost Reason object 
{
  "id": "opportunity-lost-reason_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "lost_reason": "lost_reason_example"
}
GET /api/crm/opportunity-lost-reason/{id}

Retrieve a opportunity lost reason

Retrieves the details of an existing opportunity lost reason. Supply the unique opportunity lost reason ID that was returned from a previous request.

Path parameters

id string required

The identifier of the opportunity lost reason to retrieve.

Returns

Returns the opportunity lost reason object if a valid identifier was provided.

GET /api/crm/opportunity-lost-reason/{id} 
curl https://api.overplane.dev/api/crm/opportunity-lost-reason/opportunity-lost-reason_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "opportunity-lost-reason_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "lost_reason": "lost_reason_example"
}
GET /api/crm/opportunity-lost-reason

List all opportunity lost reasons

Returns a list of opportunity lost reasons. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of opportunity lost reason objects.

GET /api/crm/opportunity-lost-reason 
curl https://api.overplane.dev/api/crm/opportunity-lost-reason \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "opportunity-lost-reason_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "lost_reason": "lost_reason_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/crm/opportunity-lost-reason

Create a opportunity lost reason

Creates a new opportunity lost reason object.

Body parameters

lost_reason string

Returns

Returns the newly created opportunity lost reason object if the call succeeded.

POST /api/crm/opportunity-lost-reason 
curl https://api.overplane.dev/api/crm/opportunity-lost-reason \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "opportunity-lost-reason_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "lost_reason": "lost_reason_example"
}
PATCH /api/crm/opportunity-lost-reason/{id}

Update a opportunity lost reason

Updates the specified opportunity lost reason by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the opportunity lost reason to update.

Body parameters

lost_reason string

Returns

Returns the updated opportunity lost reason object.

PATCH /api/crm/opportunity-lost-reason/{id} 
curl https://api.overplane.dev/api/crm/opportunity-lost-reason/opportunity-lost-reason_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"lost_reason":"lost_reason_example"}'
Response 
{
  "id": "opportunity-lost-reason_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "lost_reason": "lost_reason_example"
}
DELETE /api/crm/opportunity-lost-reason/{id}

Delete a opportunity lost reason

Permanently deletes a opportunity lost reason. This cannot be undone.

Path parameters

id string required

The identifier of the opportunity lost reason to delete.

Returns

Returns a confirmation that the opportunity lost reason has been deleted.

DELETE /api/crm/opportunity-lost-reason/{id} 
curl https://api.overplane.dev/api/crm/opportunity-lost-reason/opportunity-lost-reason_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "opportunity-lost-reason_abc123",
  "deleted": true
}