How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SendPulse Deals API

The Deals API from SendPulse — 4 operation(s) for deals.

SendPulse Deals API is one of 85 APIs that SendPulse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Deals. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against a single base URL, https://api.sendpulse.com/crm/v1.

6 operations 4 paths 11 schemas 1 DELETE1 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.sendpulse.com
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 3

SendPulse Deals API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (API Key) (apiKey). It supports OAuth 2.0 (outh2) using the clientCredentials flow. It supports OAuth 2.0 (oauth2) using the clientCredentials flow. By default, every request must be authenticated.

  • apiKey — Static API Key authentication. A long-lived token generated manually in the SendPulse account settings.
  • outh2 — OAuth 2.0 Client Credentials flow for temporary access tokens.
  • oauth2 — OAuth 2.0 Client Credentials flow for temporary access tokens.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 1 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Deals 6
POST
/deals/get-list
Get deals list
getDealsList body → 200
POST
/deals
Create a new deal
createDeal body → 200
GET
/deals/{dealId}
Get information about the deal by ID
getDeal 1 param → 200
PUT
/deals/{dealId}
Update information about a deal by its ID
updateDealById 1 param body → 200
DELETE
/deals/{dealId}
Delete a deal by its ID
deleteDeal 1 param → 204
POST
/deals/{dealId}/change-pipeline
Change the pipeline of a deal by its ID.
changeDealPipeline 1 param body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Deal (22 properties), DealDetailed (19 properties), DealComment (10 properties), DealAttributeValue (9 properties). Each schema is shown below with its type and property counts.

Deal
object
22 properties
DealExpiration
object
7 properties
FilterExpressionProperty
string
| Possible values: - eq (=) - neq (!=) - gt () - gte (=) - lt (<) - lte (<=) - like - in (check among list of values).
DealHistory
object
6 properties
DealStatusProperty
integer
| Step status 0 — inactive (deleted by user) 1 — active 2 - completed deal as “Unsuccessful” 3 - completed deal as “Successful”
EntityAttachment
object
6 properties
DealSourceType
object
2 properties
DealComment
object
10 properties
DealDetailed
object
19 properties
DealAttributeValue
object
9 properties
AttributesProperty
array
Filter by attributes only

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendpulse-deals-api-openapi.yml Raw ↑

Other APIs SendPulse publishes across the network.

SendPulse Account API
SendPulse Attachments API
SendPulse Automation Flows API
SendPulse Balance API
SendPulse Blacklist API
SendPulse Board attributes API
SendPulse Bots API
SendPulse Bounces API
SendPulse Campaigns API
SendPulse Chats API
SendPulse Checklist Items API
SendPulse Company API
Where this information came from

This is an independent, third-party profile of SendPulse Deals API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.