The Market Segment 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.

market_segment string
The Market Segment object 
{
  "id": "market-segment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "market_segment": "market_segment_example"
}
GET /api/crm/market-segment/{id}

Retrieve a market segment

Retrieves the details of an existing market segment. Supply the unique market segment ID that was returned from a previous request.

Path parameters

id string required

The identifier of the market segment to retrieve.

Returns

Returns the market segment object if a valid identifier was provided.

GET /api/crm/market-segment/{id} 
curl https://api.overplane.dev/api/crm/market-segment/market-segment_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "market-segment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "market_segment": "market_segment_example"
}
GET /api/crm/market-segment

List all market segments

Returns a list of market segments. 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 market segment objects.

GET /api/crm/market-segment 
curl https://api.overplane.dev/api/crm/market-segment \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "market-segment_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "market_segment": "market_segment_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/crm/market-segment

Create a market segment

Creates a new market segment object.

Body parameters

market_segment string

Returns

Returns the newly created market segment object if the call succeeded.

POST /api/crm/market-segment 
curl https://api.overplane.dev/api/crm/market-segment \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "market-segment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "market_segment": "market_segment_example"
}
PATCH /api/crm/market-segment/{id}

Update a market segment

Updates the specified market segment 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 market segment to update.

Body parameters

market_segment string

Returns

Returns the updated market segment object.

PATCH /api/crm/market-segment/{id} 
curl https://api.overplane.dev/api/crm/market-segment/market-segment_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"market_segment":"market_segment_example"}'
Response 
{
  "id": "market-segment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "market_segment": "market_segment_example"
}
DELETE /api/crm/market-segment/{id}

Delete a market segment

Permanently deletes a market segment. This cannot be undone.

Path parameters

id string required

The identifier of the market segment to delete.

Returns

Returns a confirmation that the market segment has been deleted.

DELETE /api/crm/market-segment/{id} 
curl https://api.overplane.dev/api/crm/market-segment/market-segment_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "market-segment_abc123",
  "deleted": true
}