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

Spruce Health Scheduled Messages API

The Scheduled Messages API from Spruce Health — 3 operation(s) for scheduled messages.

Spruce Health Scheduled Messages API is one of 15 APIs that Spruce Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 3 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

4 operations 3 paths 21 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.sprucehealth.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Spruce Health Scheduled Messages API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (spruceAPIToken). By default, every request must be authenticated.

  • spruceAPIToken — API token provided by Spruce should be passed in an "Authorization" header with the value "Bearer "

Paths & Operations 4

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

Scheduled Messages 4
GET
/conversations/{conversationId}/scheduledmessages
List any messages scheduled in a conversation
ListConversationScheduledMessages 1 param → 200400404500
POST
/conversations/{conversationId}/scheduledmessages
Schedule a message to be sent in a conversation
ScheduleConversationMessage 2 params body → 201400404422500
GET
/scheduledmessages
List any messages scheduled for the organization
ListScheduledMessages 1 param → 200400500
DELETE
/scheduledmessages/{scheduledMessageId}
Delete a scheduled message
DeleteScheduledMessage 1 param → 200400404500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are scheduledMessage (10 properties), conversationItem_Transcription (3 properties), scheduledMessage_messagePost (3 properties), conversationItem_AudioAttachment (3 properties). Each schema is shown below with its type and property counts.

conversation_id
string
Spruce's conversation ID
scheduledMessage_id
string
Spruce's scheduled message ID
conversationItem_ImageAttachment
object
2 properties 2 required
conversationItem_Transcription
object
3 properties 2 required
scheduledMessage_message
object
3 properties 3 required
scheduledMessage_sentConversationItemId
string
The id of the conversation item that was created when the scheduled message was sent. This is absent until the message has been sent.
objectType
string
String representing the object's type
error
object
3 properties 3 required
conversation_messageBodyElement
object
An element of a message body. This can be either a text or page type element. A text element is a string of text to be placed in the message. A page element is…
2 properties 2 required
totalCount
integer
paginationToken
string
Token given in a previous response to allow requesting the next page
conversationItem_Attachment
object
3 properties 2 required
scheduledMessage
object
10 properties 9 required
conversationItem_AudioAttachment
object
3 properties 2 required
scheduledMessage_messagePost
object
3 properties 1 required
conversationItem_VideoAttachment
object
2 properties 2 required
conversationItem_DocumentAttachment
object
3 properties 3 required
internalMember_id
string
The id of a team or teammate in the organization
signedUrl
object
2 properties 2 required
hasMore
boolean
conversationItem_EntityProfileAttachment
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spruce-health-scheduled-messages-api-openapi.yml Raw ↑

Other APIs Spruce Health publishes across the network.

Spruce Health Contact Fields API
Spruce Health Contact Tags API
Spruce Health Contacts API
Spruce Health Conversation Item API
Spruce Health Conversation Tags API
Spruce Health Conversations API
Spruce Health Internal Endpoints API
Spruce Health Media API
Spruce Health Organization API
Spruce Health Phone Lines API
Spruce Health Saved Messages API
Spruce Health Teams API
Where this information came from

This is an independent, third-party profile of Spruce Health Scheduled Messages 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.