AlayaCare message inbox API
The message inbox API from AlayaCare — 4 operation(s) for message inbox.
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/alayacare-message-inbox-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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: Alayacare message inbox API
version: '1.0'
servers:
- url: https://api.{env}.alayamarket.{region}/offers
variables:
env:
description: The server environment.
enum:
- staging
- sandbox
- prod
default: prod
region:
description: The server top-level domain indicating the region.
enum:
- ca
- com
- com.au
default: ca
security:
- CognitoAuthorizer: []
tags:
- name: message inbox
paths:
/v1/inbox/messages:
post:
tags:
- message inbox
description: '# Authorization
Required role: `org_admin`
# Description
Send a message for a sequence as a supply organization.
'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OrgAdminMessageSendRequest'
responses:
201:
description: Successfully sent message.
content:
application/json:
schema:
$ref: '#/components/schemas/OrgAdminMessageDetailResponse'
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${OfferApiFunctionV2.Arn}:live/invocations
httpMethod: POST
passthroughBehavior: when_no_match
type: aws_proxy
get:
tags:
- message inbox
description: '# Authorization
Required role: `org_admin`
# Description
Get a paginated collection of messages for a sequence as a supply organization.
'
parameters:
- $ref: '#/components/parameters/SequenceIdQueryParam'
- $ref: '#/components/parameters/MessageSenderTypeQueryParam'
- $ref: '#/components/parameters/MessageCategoryQueryParam'
- $ref: '#/components/parameters/PageNumberParam'
- $ref: '#/components/parameters/ItemsPerPageParam'
- in: query
name: sort_by
schema:
type: string
enum:
- created_at
default: created_at
- $ref: '#/components/parameters/SortOrderParam'
responses:
200:
description: Successfully got the messages.
content:
application/json:
schema:
$ref: '#/components/schemas/OrgAdminMessagePageResponse'
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${OfferApiFunctionV2.Arn}:live/invocations
httpMethod: POST
passthroughBehavior: when_no_match
type: aws_proxy
/v1/inbox/messages/{message_id}:
parameters:
- $ref: '#/components/parameters/MessageIdPathParam'
get:
tags:
- message inbox
description: '# Authorization
Required role: `org_admin`
# Description
Get the details of a message for a sequence as a supply organization.
'
responses:
200:
description: Successfully got the message.
content:
application/json:
schema:
$ref: '#/components/schemas/OrgAdminMessageDetailResponse'
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${OfferApiFunctionV2.Arn}:live/invocations
httpMethod: POST
passthroughBehavior: when_no_match
type: aws_proxy
/v1/inbox/messages/files/{file_id}:
parameters:
- $ref: '#/components/parameters/FileIdPathParam'
get:
tags:
- message inbox
description: '# Authorization
Required role: `org_admin`
# Description
Get the file attached to a message as a supply organization.
'
responses:
200:
description: Successfully got the file.
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${OfferApiFunctionV2.Arn}:live/invocations
httpMethod: POST
passthroughBehavior: when_no_match
type: aws_proxy
/v1/inbox/messages/files/{file_id}/presigned:
parameters:
- $ref: '#/components/parameters/FileIdPathParam'
get:
tags:
- message inbox
description: '# Authorization
Required role: `org_admin`
# Description
Get the pre-signed URL for the file attached to a message as a supply
organization.
'
responses:
200:
description: Successfully got the pre-signed URL.
content:
application/json:
schema:
$ref: '#/components/schemas/OrgAdminFilePresignedDetailResponse'
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${OfferApiFunctionV2.Arn}:live/invocations
httpMethod: POST
passthroughBehavior: when_no_match
type: aws_proxy
components:
schemas:
MessageCategoryCore:
type: string
enum:
- client_attachment
- comment
PageNumberCore:
type: integer
minimum: 1
default: 1
OrgAdminFilePresignedDetailResponse:
properties:
url:
type: string
required:
- url
PageCore:
description: Root page schema for returning collections.
type: object
properties:
page:
$ref: '#/components/schemas/PageNumberCore'
items_per_page:
$ref: '#/components/schemas/ItemsPerPageCore'
total_items:
type: integer
minimum: 0
total_pages:
type: integer
minimum: 0
required:
- page
- items_per_page
- total_items
- total_pages
OrgAdminMessageDetailResponse:
properties:
message:
type: object
title: OrgAdminMessageDetailMessageResponse
properties:
id:
type: string
format: uuid
sequence_id:
type: string
format: uuid
category:
$ref: '#/components/schemas/MessageCategoryCore'
sender_type:
$ref: '#/components/schemas/MessageSenderTypeCore'
text:
type: string
maxLength: 2500
author:
type: string
maxLength: 100
created_at:
type: string
format: date-time
file:
type: object
title: OrgAdminMessageDetailFileResponse
properties:
id:
type: string
format: uuid
url:
type: string
name:
type: string
size_in_bytes:
type: integer
minimum: 0
maximum: 52428800
required:
- id
- name
required:
- id
- sequence_id
- category
- sender_type
- created_at
sender:
type: object
title: OrgAdminMessageDetailSenderResponse
properties:
id:
type: string
format: uuid
name:
type: string
required:
- id
- name
recipient:
type: object
title: OrgAdminMessageDetailRecipientResponse
properties:
id:
type: string
format: uuid
name:
type: string
required:
- id
- name
required:
- message
- sender
- recipient
SortOrderCore:
type: string
enum:
- asc
- desc
default: desc
ItemsPerPageCore:
type: integer
minimum: 1
default: 100
OrgAdminMessageCollectionResponse:
properties:
id:
type: string
format: uuid
category:
$ref: '#/components/schemas/MessageCategoryCore'
sender_type:
$ref: '#/components/schemas/MessageSenderTypeCore'
text:
type: string
maxLength: 2500
author:
type: string
maxLength: 100
created_at:
type: string
format: date-time
file:
type: object
title: MessageCollectionFileResponse
properties:
id:
type: string
format: uuid
name:
type: string
required:
- id
- name
required:
- id
- category
- sender_type
- created_at
OrgAdminMessagePageResponse:
allOf:
- $ref: '#/components/schemas/PageCore'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/OrgAdminMessageCollectionResponse'
required:
- items
MessageSenderTypeCore:
type: string
enum:
- demand
- supply
OrgAdminMessageSendRequest:
properties:
sequence_id:
type: string
format: uuid
category:
$ref: '#/components/schemas/MessageCategoryCore'
text:
type: string
maxLength: 2500
author:
type: string
maxLength: 100
file:
type: object
title: OrgAdminMessageSendFileRequest
properties:
url:
type: string
name:
type: string
size_in_bytes:
type: integer
minimum: 0
maximum: 52428800
required:
- url
- name
required:
- sequence_id
- category
parameters:
ItemsPerPageParam:
in: query
name: items_per_page
schema:
$ref: '#/components/schemas/ItemsPerPageCore'
MessageIdPathParam:
in: path
name: message_id
schema:
type: string
format: uuid
required: true
description: ID of a message.
FileIdPathParam:
in: path
name: file_id
schema:
type: string
format: uuid
required: true
description: ID of a file.
PageNumberParam:
in: query
name: page
schema:
$ref: '#/components/schemas/PageNumberCore'
SequenceIdQueryParam:
in: query
name: sequence_id
schema:
type: string
format: uuid
required: true
SortOrderParam:
in: query
name: sort_order
schema:
$ref: '#/components/schemas/SortOrderCore'
MessageSenderTypeQueryParam:
in: query
name: sender_type
schema:
$ref: '#/components/schemas/MessageSenderTypeCore'
MessageCategoryQueryParam:
in: query
name: category
schema:
$ref: '#/components/schemas/MessageCategoryCore'
securitySchemes:
CognitoAuthorizer:
type: apiKey
name: Authorization
in: header
x-amazon-apigateway-authtype: cognito_user_pools
x-amazon-apigateway-authorizer:
type: cognito_user_pools
providerARNs:
- Fn::Sub: '{{resolve:ssm:/${StackName}/${UserPoolArnSSMParameterName}}}'
x-amazon-apigateway-request-validators:
body:
validateRequestBody: true
validateRequestParameters: false
params:
validateRequestBody: false
validateRequestParameters: true
params-and-body:
validateRequestBody: true
validateRequestParameters: true
x-amazon-apigateway-request-validator: params
x-amazon-apigateway-gateway-responses:
BAD_REQUEST_BODY:
statusCode: 400
responseTemplates:
application/json: '{"message": $context.error.messageString, "description": "$context.error.validationErrorString"}'