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

Sendlane Contacts API

The Contacts API from Sendlane — 18 operation(s) for contacts.

Sendlane Contacts API is one of 14 APIs that Sendlane publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contacts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, rate-limit docs, and authentication docs.

This API exposes 26 operations across 18 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://api.sendlane.com/v2.

26 operations 18 paths 29 schemas 5 DELETE15 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://api.sendlane.com/v2
Authentication
API Key, API Key
Contact
Resource Areas
1

Authentication & Security 2

Sendlane Contacts API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (BearerToken). An API key is passed in the header as Authorization-Destination (OtherAccountBearerToken). By default, every request must be authenticated.

  • BearerToken — API token sent in the Authorization header with the value "Bearer {apiToken}"
  • OtherAccountBearerToken — API token for other account sent in the Authorization-Destination header with the value "Bearer {apiToken}"

Paths & Operations 26

Across 18 paths, the API surfaces 26 operations — 5 DELETE, 15 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Contacts 26
GET
/contacts
Contacts
get-contacts 2 params → 200
GET
/contacts/{contactId}
Get Contact
get-contacts-contactId 1 param → 200
DELETE
/contacts/{contactId}
Delete Contact
delete-contacts-contactId 1 param → 202
GET
/contacts/unsubscribed
Contacts Unsubscribed
get-contacts-unsubscribed 2 params → 200
GET
/contacts/{contactId}/custom-fields
Get Contact Custom Fields
get-contacts-contactId-custom-fields 1 param → 200
POST
/contacts/{contactId}/custom-fields
Add Contact Custom Field
post-contacts-contactId-custom-fields 1 param body → 200
GET
/contacts/{contactId}/custom-fields/{contactCustomFieldId}
Get Contact Custom Field
get-contacts-contactId-custom-fields-contactCustomFieldId 1 param → 200
DELETE
/contacts/{contactId}/custom-fields/{contactCustomFieldId}
Remove Custom Field from Contact
delete-contacts-contactId-custom-fields-contactCustomFieldId 1 param → 202
POST
/contacts/{contactId}/email-consent
Contact Email Consent
post-contacts-email-consent 1 param body → 200
GET
/contacts/{contactId}/history
Contact History
get-contacts-history 1 param body → 200
GET
/contacts/search
Contact Search
get-contacts-search body → 200
GET
/contacts/{contactId}/segments
Contact Segments
get-contacts-segments 1 param → 200
GET
/contacts/{contactId}/subscriptions
Contact Subscriptions
get-contacts-subscriptions 1 param → 200
GET
/contacts/subscriptions
Contact Search Subscriptions
get-search-contacts-subscriptions body → 200
GET
/contacts/{contactId}/sms-consent
Get Contact SMS Consent
get-contacts-contactId-sms-consent 1 param → 200
POST
/contacts/{contactId}/sms-consent
Contact Add SMS Consent
post-contacts-sms-consent 1 param body → 200
DELETE
/contacts/{contactId}/sms-consent
Remove SMS Consent from Contact
delete-contacts-contactId-sms-consent 1 param → 200
POST
/contacts/sms-consent
Contact Search and Add SMS Consent
post-contacts-search-sms-consent body → 202
GET
/contacts/{contactId}/tags
Get Contact Tags
get-contacts-contactId-tags 1 param → 200
POST
/contacts/{contactId}/tags
Add Contact Tag
post-contacts-contactId-tags 1 param body → 200
GET
/contacts/{contactId}/tags/{tagId}
Get Contact Tag
get-contacts-contactId-tags-tagId 1 param → 200
DELETE
/contacts/{contactId}/tags/{tagId}
Remove Tag from Contact
delete-contacts-contactId-tags-tagId 1 param → 202
POST
/contacts/{contactId}/unsubscribe
Contact Unsubscribe
post-contacts-unsubscribe 1 param → 200
GET
/back-in-stock-contacts
Back In Stock Contacts
get-back-in-stock-contacts → 200
GET
/back-in-stock-contacts/{contactId}
Get Back In Stock Contact
get-back-in-stock-contacts-contactId 1 param → 200
DELETE
/back-in-stock-contacts/{contactId}
Delete Back In Stock Contact
delete-back-in-stock-contacts-contactId 1 param → 202

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are ContactHistory.v2 (14 properties), Contact.v2 (13 properties), ContactSearchSmsConsentRequest.v2 (9 properties), Subscription.v2 (8 properties). Each schema is shown below with its type and property counts.

ContactSearchSmsConsentRequest.v2
object
9 properties 6 required
ContactResponse.v2
object
1 property 1 required
TagIndexResponse.v2
object
3 properties
ContactHistoryRequest.v2
object
1 property
ContactCustomFieldStoreRequest.v2
object
1 property 1 required
ContactSearchRequest.v2
object
2 properties
SmsConsentResponse.v2
object
1 property 1 required
Contact.v2
object
13 properties
AcceptedResponse.v2
object
1 property
ContactEmailConsentRequest.v2
object
2 properties 1 required
PaginatorLinks.v2
object
4 properties
Subscription.v2
object
8 properties
ContactUnsubscribeResponse.v2
object
1 property
BackInStockContact.v2
object
7 properties
ContactHistory.v2
object
14 properties
ContactCustomFieldResponse.v2
object
1 property 1 required
PaginatorMeta.v2
object
7 properties
ContactTag.v2
object
2 properties
SmsConsent.v2
object
4 properties
ContactTagStoreRequest.v2
object
1 property 1 required
ContactSmsConsentRequest.v2
object
8 properties 6 required
TagResponse.v2
object
1 property
CustomField.v2
object
4 properties 1 required
ContactCustomField.v2
object
5 properties 2 required
Segment.v2
object
8 properties
ContactSubscriptionsRequest.v2
object
2 properties
ContactList.v2
object
2 properties
Tag.v2
object
4 properties 1 required
BackInStockContactResponse.v2
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendlane-contacts-api-openapi.yml Raw ↑

Other APIs Sendlane publishes across the network.

Sendlane Automations API
Sendlane Campaigns API
Sendlane Custom Fields API
Sendlane Custom Integration Events API
Sendlane Custom Integration Webhooks API
Sendlane Custom Integrations API
Sendlane List Contacts API
Sendlane Lists API
Sendlane Segments API
Sendlane Senders API
Sendlane SMS API
Sendlane Suppression API
Where this information came from

This is an independent, third-party profile of Sendlane Contacts 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.