The Party Specific Item 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.

party_type string required
party string required
restrict_based_on string required
based_on_value string required
The Party Specific Item object 
{
  "id": "party-specific-item_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "party_type": "party_type_example",
  "party": "party_example",
  "restrict_based_on": "restrict_based_on_example",
  "based_on_value": "based_on_value_example"
}
GET /api/crm/party-specific-item/{id}

Retrieve a party specific item

Retrieves the details of an existing party specific item. Supply the unique party specific item ID that was returned from a previous request.

Path parameters

id string required

The identifier of the party specific item to retrieve.

Returns

Returns the party specific item object if a valid identifier was provided.

GET /api/crm/party-specific-item/{id} 
curl https://api.overplane.dev/api/crm/party-specific-item/party-specific-item_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "party-specific-item_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "party_type": "party_type_example",
  "party": "party_example",
  "restrict_based_on": "restrict_based_on_example",
  "based_on_value": "based_on_value_example"
}
GET /api/crm/party-specific-item

List all party specific items

Returns a list of party specific items. 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 party specific item objects.

GET /api/crm/party-specific-item 
curl https://api.overplane.dev/api/crm/party-specific-item \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "party-specific-item_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "party_type": "party_type_example",
      "party": "party_example",
      "restrict_based_on": "restrict_based_on_example",
      "based_on_value": "based_on_value_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/crm/party-specific-item

Create a party specific item

Creates a new party specific item object.

Body parameters

party_type string required
party string required
restrict_based_on string required
based_on_value string required

Returns

Returns the newly created party specific item object if the call succeeded.

POST /api/crm/party-specific-item 
curl https://api.overplane.dev/api/crm/party-specific-item \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"party_type":"party_type_example","party":"party_example","restrict_based_on":"restrict_based_on_example","based_on_value":"based_on_value_example"}'
Response 
{
  "id": "party-specific-item_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "party_type": "party_type_example",
  "party": "party_example",
  "restrict_based_on": "restrict_based_on_example",
  "based_on_value": "based_on_value_example"
}
PATCH /api/crm/party-specific-item/{id}

Update a party specific item

Updates the specified party specific item 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 party specific item to update.

Body parameters

party_type string
party string
restrict_based_on string
based_on_value string

Returns

Returns the updated party specific item object.

PATCH /api/crm/party-specific-item/{id} 
curl https://api.overplane.dev/api/crm/party-specific-item/party-specific-item_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"party_type":"party_type_example","party":"party_example"}'
Response 
{
  "id": "party-specific-item_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "party_type": "party_type_example",
  "party": "party_example",
  "restrict_based_on": "restrict_based_on_example",
  "based_on_value": "based_on_value_example"
}
DELETE /api/crm/party-specific-item/{id}

Delete a party specific item

Permanently deletes a party specific item. This cannot be undone.

Path parameters

id string required

The identifier of the party specific item to delete.

Returns

Returns a confirmation that the party specific item has been deleted.

DELETE /api/crm/party-specific-item/{id} 
curl https://api.overplane.dev/api/crm/party-specific-item/party-specific-item_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "party-specific-item_abc123",
  "deleted": true
}