API Endpoints Reference ================== This section provides a comprehensive list of all available API endpoints in the Salesbox API. General ------- .. code-block:: text GET /api/endpoints GET /api/version Authentication ------------- .. code-block:: text POST /api/oauth/v2/token POST /api/oauth/v2/revoke Assets ------ .. code-block:: text GET /api/assets POST /api/assets GET /api/assets/{id} PUT /api/assets/{id} DELETE /api/assets/{id} Campaigns -------- .. code-block:: text GET /api/campaigns POST /api/campaigns GET /api/campaigns/{id} PUT /api/campaigns/{id} DELETE /api/campaigns/{id} Contacts ------- .. code-block:: text GET /api/contacts POST /api/contacts GET /api/contacts/{id} PUT /api/contacts/{id} DELETE /api/contacts/{id} Fields ----- .. code-block:: text GET /api/fields POST /api/fields GET /api/fields/{id} PUT /api/fields/{id} DELETE /api/fields/{id} Notifications ----------- .. code-block:: text GET /api/notifications POST /api/notifications GET /api/notifications/{id} PUT /api/notifications/{id} DELETE /api/notifications/{id} Point Groups ---------- .. code-block:: text GET /api/point_groups POST /api/point_groups GET /api/point_groups/{id} PUT /api/point_groups/{id} DELETE /api/point_groups/{id} Reports ------ .. code-block:: text GET /api/reports POST /api/reports GET /api/reports/{id} PUT /api/reports/{id} DELETE /api/reports/{id} Text Messages ----------- .. code-block:: text GET /api/text_messages POST /api/text_messages GET /api/text_messages/{id} PUT /api/text_messages/{id} DELETE /api/text_messages/{id} Contacts -------- Manage contacts in your Salesbox account. List Contacts ~~~~~~~~~~~~ .. code-block:: text GET /contacts Parameters: * ``page`` (optional): Page number for pagination * ``limit`` (optional): Number of records per page * ``search`` (optional): Search term to filter contacts Create Contact ~~~~~~~~~~~~~ .. code-block:: text POST /contacts Required fields: * ``name``: Contact's full name * ``email``: Contact's email address Optional fields: * ``phone``: Phone number * ``company``: Company name * ``title``: Job title Deals ----- Manage deals in your sales pipeline. List Deals ~~~~~~~~~ .. code-block:: text GET /deals Parameters: * ``page`` (optional): Page number for pagination * ``limit`` (optional): Number of records per page * ``status`` (optional): Filter by deal status Create Deal ~~~~~~~~~~ .. code-block:: text POST /deals Required fields: * ``title``: Deal name * ``value``: Deal value * ``contact_id``: Associated contact ID Optional fields: * ``expected_close_date``: Expected closing date * ``stage``: Deal stage * ``probability``: Win probability Activities --------- Track and manage sales activities. List Activities ~~~~~~~~~~~~~ .. code-block:: text GET /activities Parameters: * ``page`` (optional): Page number for pagination * ``limit`` (optional): Number of records per page * ``type`` (optional): Filter by activity type Create Activity ~~~~~~~~~~~~~ .. code-block:: text POST /activities Required fields: * ``type``: Activity type (call, email, meeting) * ``subject``: Activity subject * ``contact_id``: Associated contact ID Optional fields: * ``due_date``: Due date for the activity * ``notes``: Additional notes * ``outcome``: Activity outcome