BigChange Messages API
The Messages API from BigChange — 1 operation(s) for messages.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/bigchange:bigchange-messages-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: BigChange DX Messages API
description: Developer Experience API
version: '1.0'
servers:
- url: https://api.bigchange.com
security:
- bearer: []
tags:
- name: Messages
paths:
/v1/messages:
post:
tags:
- Messages
summary: Send a message to a single recipient
description: 'Sends a message to a single recipient. Supported recipient types: device, resourceGroup, webUser, resourceGroupMobile, resourceMobile, userMobile, userEmail, email, mobileNumber. (required scope messages:write)'
parameters:
- name: Customer-Id
in: header
description: The customer identifier
required: true
schema:
type: integer
format: int64
requestBody:
description: The message payload
content:
application/json:
schema:
$ref: '#/components/schemas/SendMessageModel'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/SendMessageResponseModel'
'400':
description: Bad Request
content:
application/problem+json:
schema:
oneOf:
- $ref: '#/components/schemas/ProblemDetails'
- $ref: '#/components/schemas/HttpValidationProblemDetails'
'403':
description: Forbidden
content:
application/problem+json:
schema:
oneOf:
- $ref: '#/components/schemas/ProblemDetails'
- $ref: '#/components/schemas/HttpValidationProblemDetails'
'422':
description: Unprocessable Content
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ValidationProblemDetails'
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
oneOf:
- $ref: '#/components/schemas/ProblemDetails'
- $ref: '#/components/schemas/HttpValidationProblemDetails'
operationId: postV1Messages
x-operation-id-source: derived
components:
schemas:
RecipientType:
enum:
- device
- resourceGroup
- webUser
- resourceGroupMobile
- resourceMobile
- userMobile
- userEmail
- email
- mobileNumber
type: string
description: 'The type of recipient for a message.<p>Possible values:</p><ul><li><b>device</b>: A tracked device assigned to a resource</li><li><b>resourceGroup</b>: A resource group (all devices in the group)</li><li><b>webUser</b>: A web user</li><li><b>resourceGroupMobile</b>: A resource group (SMS to all mobiles in the group)</li><li><b>resourceMobile</b>: A resource — sends SMS to the resource''s mobile number</li><li><b>userMobile</b>: A web user — sends SMS to the user''s mobile number</li><li><b>userEmail</b>: A web user — sends an email to the user''s email address</li><li><b>email</b>: An arbitrary email address supplied in</li><li><b>mobileNumber</b>: An arbitrary mobile number supplied in</li></ul>'
example: device
ValidationProblemDetails:
type: object
properties:
errors:
type: object
additionalProperties:
type: array
items:
type: string
type:
type:
- string
- 'null'
description: A URI reference [RFC3986] that identifies the problem type
example: https://example.com/probs/out-of-credit
title:
type:
- string
- 'null'
description: A short, human-readable summary of the problem type
example: You do not have enough credit
status:
type:
- integer
- 'null'
description: The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
format: int32
example: 403
detail:
type:
- string
- 'null'
description: A human-readable explanation specific to this occurrence of the problem
example: Your current balance is 30, but that costs 50
instance:
type:
- string
- 'null'
description: A URI reference that identifies the specific occurrence of the problem
example: /account/12345/msgs/abc
additionalProperties: {}
ProblemDetails:
type: object
properties:
type:
type:
- string
- 'null'
description: A URI reference [RFC3986] that identifies the problem type
example: https://example.com/probs/out-of-credit
title:
type:
- string
- 'null'
description: A short, human-readable summary of the problem type
example: You do not have enough credit
status:
type:
- integer
- 'null'
description: The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
format: int32
example: 403
detail:
type:
- string
- 'null'
description: A human-readable explanation specific to this occurrence of the problem
example: Your current balance is 30, but that costs 50
instance:
type:
- string
- 'null'
description: A URI reference that identifies the specific occurrence of the problem
example: /account/12345/msgs/abc
additionalProperties: {}
HttpValidationProblemDetails:
type: object
allOf:
- $ref: '#/components/schemas/ProblemDetails'
properties:
errors:
type: object
additionalProperties:
type: array
items:
type: string
additionalProperties: {}
SendMessageModel:
required:
- recipientType
type: object
properties:
recipientType:
$ref: '#/components/schemas/RecipientType'
recipientId:
type:
- integer
- 'null'
description: 'The unique identifier of the recipient.<br/>Required for entity-based recipient types: device, resourceGroup, webUser, resourceGroupMobile, resourceMobile, userMobile, userEmail'
format: int64
recipientAddress:
type:
- string
- 'null'
description: 'The recipient address.<br/>Required for address-based recipient types: email (supply a valid email address), mobileNumber (supply a number in international format, e.g. +44 7777 123456)'
body:
type: string
description: The message body. Maximum 1000 characters
subject:
type:
- string
- 'null'
description: The message subject. Maximum 50 characters. Optional — ignored for SMS recipient types (resourceMobile, userMobile, resourceGroupMobile)
additionalProperties: false
description: Represents the request body for sending a message
SendMessageResponseModel:
type: object
properties:
messageId:
type: integer
description: The unique identifier for the sent message
format: int64
status:
type: string
description: 'The delivery status of the message. Possible values: queued, sent, failed'
sentAt:
type: string
description: The UTC timestamp at which the message was sent
format: date-time
additionalProperties: false
description: Represents the response body returned after a message is sent
securitySchemes:
bearer:
type: http
description: Enter the access token only.
scheme: bearer
bearerFormat: JWT