> ## Documentation Index > Fetch the complete documentation index at: https://docs.1club.ai/llms.txt > Use this file to discover all available pages before exploring further. # Create a message draft > Writes a **draft**. It is never sent by this API: there is no send endpoint. The draft appears in the admin app, where a member of staff reviews it and sends it. Tell whoever asked for it that it is waiting there. Name the audience with exactly one of `contactIds` (specific contacts, all of which must belong to the organization, at most 5,000) or `segment` (a filter resolved when the draft is sent - **an empty `segment` is every contact**). `type` is `email`, `sms` or `whatsapp`; push notifications cannot be composed. An email needs a `subject`. `content` is a string (HTML for email, which is sanitized; text for SMS and WhatsApp) or an object with `html` or Editor.js `blocks`. The draft is attributed to a member of staff: the one an assistant is acting for, or for an API key the person who created the key - refused (403) when they are no longer an active member of the organization. It is stamped `source: api`. Supports the `Idempotency-Key` header. ## OpenAPI ````yaml /openapi-platform.json post /v1/platform/messages openapi: 3.0.0 info: title: 1club Platform API version: 1.0.0 description: >- The 1club Platform API lets you programmatically access and manage your organization's data. ## Official API Contract This documentation is the official source of truth for the 1club Platform API. If an integration relies on undocumented endpoints, fields, response shapes, or internal behavior outside this spec, we can't guarantee backward compatibility. Build against what's documented here to stay stable as the platform evolves. ## Authentication All requests require a customer API key passed as a Bearer token: ``` Authorization: Bearer 1club_sk_live_... ``` Generate API keys from the admin portal under **Settings > API Tokens**. The key is tied to your organization - all responses are scoped to your org's data. Agents and MCP connectors can instead send an OAuth access token (the `platformOAuth` scheme), requesting only the scopes the task needs. ## Rate Limiting - **100 requests per minute** per API key - When exceeded, the API returns `429 Too Many Requests` with a `Retry-After` header - Rate limit headers are included in every response: - `X-RateLimit-Limit` - max requests per window - `X-RateLimit-Remaining` - requests remaining - `X-RateLimit-Reset` - seconds until the window resets ## Errors | Status | Meaning | |--------|---------| | `400` | Invalid request parameters | | `401` | Missing or invalid API key | | `404` | Resource not found (or doesn't belong to your organization) | | `429` | Rate limit exceeded | | `500` | Internal server error | ## Versioning and deprecation The API is versioned in the path (`/v1`). Changes within a version are additive: new endpoints, new optional parameters and new response fields can appear at any time, so clients should ignore fields they do not recognise. A breaking change ships as a new version. An operation due to be removed is first marked `deprecated: true` in this spec and announced in the changelog at https://docs.1club.ai/changelog, with advance notice before it is withdrawn. contact: name: 1club API Support email: support@1club.ai servers: - url: https://api.1club.ai description: Production API security: - customerApiAuth: [] - platformOAuth: [] tags: [] paths: /v1/platform/messages: post: tags: - Messages summary: Create a message draft description: > Writes a **draft**. It is never sent by this API: there is no send endpoint. The draft appears in the admin app, where a member of staff reviews it and sends it. Tell whoever asked for it that it is waiting there. Name the audience with exactly one of `contactIds` (specific contacts, all of which must belong to the organization, at most 5,000) or `segment` (a filter resolved when the draft is sent - **an empty `segment` is every contact**). `type` is `email`, `sms` or `whatsapp`; push notifications cannot be composed. An email needs a `subject`. `content` is a string (HTML for email, which is sanitized; text for SMS and WhatsApp) or an object with `html` or Editor.js `blocks`. The draft is attributed to a member of staff: the one an assistant is acting for, or for an API key the person who created the key - refused (403) when they are no longer an active member of the organization. It is stamped `source: api`. Supports the `Idempotency-Key` header. operationId: createMessage parameters: - in: header name: Idempotency-Key schema: type: string maxLength: 255 description: >- Retry-safe key; a repeat of the same request replays the first response requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PlatformMessageDraftCreate' responses: '201': description: Draft created. Not sent. content: application/json: schema: $ref: '#/components/schemas/PlatformMessage' '400': $ref: '#/components/responses/PlatformBadRequest' '401': $ref: '#/components/responses/PlatformUnauthorized' '403': description: > API key is missing the required `messages:write` scope, a contact is not in this organization, or the key's creator can no longer be named as the draft's author content: application/json: schema: $ref: '#/components/schemas/PlatformError' '409': $ref: '#/components/responses/PlatformConflict' '429': $ref: '#/components/responses/PlatformRateLimited' security: - customerApiAuth: [] components: schemas: PlatformMessageDraftCreate: type: object description: >- A new draft. It is never sent through this API: a member of staff reviews and sends it in the admin app. Name the audience with exactly one of `contactIds` or `segment`. required: - type - content additionalProperties: false properties: type: type: string enum: - email - sms - whatsapp description: >- The channel, fixed once drafted. Push notifications cannot be composed. subject: type: string minLength: 1 maxLength: 200 description: Required for email. content: description: >- The body. A string is HTML for email (sanitized) and plain text for SMS and WhatsApp. Or an object with `html` and/or Editor.js `blocks`, the shape the admin composer saves. oneOf: - type: string minLength: 1 - type: object additionalProperties: false properties: html: type: string blocks: type: object description: 'Editor.js blocks: { blocks: [{ type, data }] }.' required: - blocks properties: time: type: number blocks: type: array items: type: object required: - type - data properties: id: type: string type: type: string example: paragraph data: type: object tunes: type: object version: type: string contactIds: type: array minItems: 1 maxItems: 5000 items: type: integer description: >- A hand-picked audience: contact ids, each in this organization. Mutually exclusive with `segment`. segment: $ref: '#/components/schemas/PlatformMessageSegment' PlatformMessage: type: object description: >- An email, SMS or WhatsApp Message. This API writes drafts only; it never sends one. properties: id: type: integer uuid: type: string format: uuid type: type: string description: email, sms or whatsapp direction: type: string enum: - outbound - inbound status: type: string enum: - draft - sent description: >- draft: waiting for a member of staff to send it in the admin app; editable. sent: gone out (or received), read-only. subject: type: string description: Empty for SMS and WhatsApp. content: type: object description: The body as stored. On a single read and on writes; not in the list. properties: html: type: string nullable: true blocks: type: object description: 'Editor.js blocks: { blocks: [{ type, data }] }.' required: - blocks properties: time: type: number blocks: type: array items: type: object required: - type - data properties: id: type: string type: type: string example: paragraph data: type: object tunes: type: object version: type: string nullable: true preview: type: string description: The start of the body as plain text. source: type: string nullable: true description: >- `api` for a draft written through this API or MCP; other values for Messages written in 1club; null when not recorded. sender: type: object nullable: true description: >- The member of staff the Message is attributed to. For an API-key draft, the person who created the key. properties: userId: type: integer name: type: string nullable: true audience: type: object properties: mode: type: string enum: - manual - segment description: >- manual: the contacts in `recipients`. segment: whoever matches `segment` when it is sent. segment: allOf: - $ref: '#/components/schemas/PlatformMessageSegment' nullable: true description: The filter of a segment audience; null for a manual one. recipientCount: type: integer recipients: type: array items: $ref: '#/components/schemas/PlatformMessageRecipient' description: >- On a single read and on writes; not in the list. Empty on a segment draft, whose audience is resolved when it is sent. replyToMessageId: type: integer nullable: true description: The Message this one replies to, within a conversation. sentAt: type: string format: date-time nullable: true description: When it went out; null for a draft. createdAt: type: string format: date-time PlatformError: type: object properties: error: type: string code: type: string description: >- A stable, machine-readable reason, when the error has one (e.g. `CONTACT_EXISTS`). details: type: object additionalProperties: true description: >- Structured values behind the error. A 409 naming an existing record carries its id here, e.g. `contactId`. PlatformMessageSegment: type: object additionalProperties: false description: >- An audience resolved at the moment a member of staff sends the draft, so it includes whoever matches by then. Every criterion narrows it; **an empty object is every contact in the organization**. Mutually exclusive with `contactIds`. properties: type: type: array items: type: string description: Contact types, e.g. member, lead. clubId: type: integer description: Contacts of this club. tags: type: array items: oneOf: - type: integer - type: string maxItems: 50 description: Tag ids. membershipPlanIds: type: array items: type: integer maxItems: 50 description: Holding a current membership on any of these plans. membershipPlanCategoryIds: type: array items: type: integer maxItems: 50 description: Holding a current membership in any of these plan categories. pipelineStageIds: type: array items: type: integer maxItems: 50 description: In any of these pipeline stages. sourceIds: type: array items: type: integer maxItems: 50 description: Came from any of these contact sources. progressionLevelIds: type: array items: type: integer maxItems: 50 description: >- At any of these progression levels or above on its track ("blue belt and up"). PlatformMessageRecipient: type: object description: One person on a Message and how it landed for them. properties: contactId: type: integer name: type: string nullable: true deliveryStatus: type: string description: >- queued until sent; then what the provider reported (sent, processed, delivered, deferred, bounced, dropped, failed, spam, unsubscribed), or skipped when it was never sent to this person. engagementStatus: type: string nullable: true enum: - open - click - unsubscribe - spamreport description: What the person did with it, where the channel reports it. skippedReason: type: string nullable: true description: >- Why it was not sent to this person (unsubscribed, suppressed, no address on file). sentAt: type: string format: date-time nullable: true deliveredAt: type: string format: date-time nullable: true openedAt: type: string format: date-time nullable: true clickedAt: type: string format: date-time nullable: true bouncedAt: type: string format: date-time nullable: true failedAt: type: string format: date-time nullable: true unsubscribedAt: type: string format: date-time nullable: true responses: PlatformBadRequest: description: Invalid request (bad parameters, or a body that fails validation) content: application/json: schema: $ref: '#/components/schemas/PlatformError' PlatformUnauthorized: description: Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/PlatformError' PlatformConflict: description: >- The request conflicts with existing state, or reuses an Idempotency-Key with a different body content: application/json: schema: $ref: '#/components/schemas/PlatformError' PlatformRateLimited: description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/PlatformError' securitySchemes: customerApiAuth: type: http scheme: bearer description: >- Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token. platformOAuth: type: oauth2 description: >- OAuth 2.1 authorization code flow with PKCE (S256), as used by MCP connectors. Register a client dynamically (RFC 7591) at https://api.1club.ai/v1/mcp/oauth/register. Each scope grants one capability; request only what the integration needs. flows: authorizationCode: authorizationUrl: https://auth.1club.ai/oauth/authorize tokenUrl: https://api.1club.ai/v1/mcp/oauth/token scopes: '*': >- Full access - read and manage everything in this organization, including capabilities added later classes:read: View classes, class types, schedules and progression tracks classes:write: >- Create, reschedule, and cancel classes, and maintain the class types they are run as checkins:read: View check-ins checkins:write: Check people in, to a booking or on their membership content:read: View published content content:write: >- Create, edit and delete content - posts, FAQs, documents and reusable blocks website:read: >- View your website: pages, sections, layout, styles and publish history website:write: >- Edit your website - pages, sections, navigation and styles. Edits stay unpublished until published. website:publish: >- Publish your website, making unpublished edits visible to the public, and roll back to an earlier version media:read: View your media library media:write: >- Add images and videos to your media library and edit their names and descriptions media:delete: Permanently delete files from your media library clubs:read: View club information clubs:write: >- Edit your clubs' details - name, contact details, address, opening hours, amenities and sports. Live on your website, member portal, app and 1club.me at once; a club listed on 1club.me sends its listing's changes for review. transactions:read: View transactions, revenue reports and your chart of accounts transactions:write: >- Record revenue collected outside 1club, such as a marketplace payout for your bookings, and refunds of it. Nothing is charged to anyone. invoices:read: >- View your invoices - who they were issued to, their amounts and status - and how much was invoiced over a period areas:read: View areas, area types, blocks and availability areas:write: >- Create and update areas and area types, and block or unblock an area bookings:read: View bookings bookings:write: >- Create, change, reschedule and cancel bookings, and add or remove participants contacts:read: >- View contacts, their tags and custom field values, and your sales pipeline stages and sources contacts:write: >- Create and update contacts and tag them, and maintain your tags, smart tag rules and contact custom fields contacts:delete: >- Archive contacts, which cancels their active memberships and all their future bookings. Separate from creating and updating because those cancellations are not undone by restoring the contact. instructors:read: View instructors and their availability instructors:write: >- Create and update instructors (coaches) and the instructor types they are grouped by, including what members pay for a one-to-one session and how you pay the coach. Does not grant admin-portal access: an instructor created this way has no login and is never invited to your staff portal. plans:read: View plans and pricing plans:write: Create, edit and delete plans and plan categories memberships:read: View memberships memberships:write: >- Sell memberships, set their price and whether they are paid, and pause, resume or cancel them products:read: >- View the product catalogue and its categories, including prices and how many are left to sell products:write: Create and edit products and product categories forms:read: >- View your forms and their questions, and how many people have completed each. Not the answers themselves. forms:write: >- Create and edit forms and their questions, including sign-up forms that sell your plans and products. Forms are public as soon as they are created or changed. Does not delete forms. organization:write: >- Change organization-wide settings, which take effect immediately. That includes which languages you offer, across your website, the member portal, the mobile app and email, and what your clubs call their booking cards (private training, group activities, areas) wherever members book. revenue-accounts:write: >- Add accounts to your chart of accounts and edit them, including which one sales post to by default. Reading the chart needs no scope of its own - any of plans, products or transactions admits it. pricing-rules:read: >- View pricing rules - the surcharges, discounts and set prices applied when a booking is priced - and quote what a booking would cost pricing-rules:write: >- Create, edit, turn off and delete pricing rules. Changes apply to every booking priced afterwards. booking-policies:read: >- View booking policies: cancellation and refund rules, payment timing and booking windows booking-policies:write: >- Create, edit, duplicate and delete booking policies. Changes apply to every booking they cover from then on. document-rules:read: >- View document rules - which members are asked to sign or accept which documents, such as waivers document-rules:write: >- Create, edit and delete document rules, which decide who must sign or accept a document and whether it is required for entry templates:read: View your email and SMS templates templates:write: Create, edit and delete email and SMS templates events:read: View events, their tickets and how many are sold events:write: >- Create, edit, duplicate and delete events, and publish, unpublish or cancel them. Cancelling an event also cancels its attendees' bookings. messages:read: >- View messages sent to and received from your members, and their delivery status messages:write: >- Prepare draft messages to members. Drafts are never sent from here: someone at your club reviews and sends them from 1club. analytics:read: >- View statistics over a period - revenue, bookings, check-ins, how full your classes, courts and coaches were, memberships added and cancelled, and new members - as totals, never the people or sales behind them payment-methods:write: >- Add, rename and remove the payment methods staff record by hand, such as cash or a bank transfer, and choose which ones members may pick when paying for a booking. Reading them needs no scope of its own - transactions:read admits it. staff:read: >- View your staff accounts, their roles, and what each role is allowed to do staff:write: >- Change a staff member's role, and what the manager, front desk and instructor roles are allowed to do. Only a signed-in person can use it, with the same limits as in 1club: an API key is always refused. notifications:read: >- View which notifications each role gets by default, and on which channels notifications:write: >- Change which notifications each role gets and on which channels, and apply those defaults to everyone in a role, replacing their own choices ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.