NudgeLink Activation API

The activation API from NudgeLink — 2 operation(s) for activation.

GitHub OpenAPI

Operations 2

POST /api/v1/activation/start Activation Start #
GET /api/v1/activation/checklist Getting Started Checklist #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nudgelink-co:nudgelink-co-activation-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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nudgelink-co-activation-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NudgeLink Activation API
  version: 0.1.0
tags:
- name: activation
paths:
  /api/v1/activation/start:
    post:
      tags:
      - activation
      summary: Activation Start
      operationId: activation_start_api_v1_activation_start_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivationStartRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivationStartResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/activation/checklist:
    get:
      tags:
      - activation
      summary: Getting Started Checklist
      operationId: getting_started_checklist_api_v1_activation_checklist_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/app__api__activation__ChecklistOut'
      security:
      - HTTPBearer: []
components:
  schemas:
    app__api__activation__ChecklistOut:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ChecklistItemOut'
          type: array
          title: Items
      type: object
      required:
      - items
      title: ChecklistOut
    ActivationStartRequest:
      properties:
        suggestion_id:
          type: string
          format: uuid
          title: Suggestion Id
        mode:
          type: string
          const: preview
          title: Mode
          default: preview
      type: object
      required:
      - suggestion_id
      title: ActivationStartRequest
    ActivationStartResponse:
      properties:
        lead_id:
          type: string
          format: uuid
          title: Lead Id
        sequence_id:
          type: string
          format: uuid
          title: Sequence Id
        message_id:
          type: string
          format: uuid
          title: Message Id
        step:
          type: string
          title: Step
        preview_status:
          anyOf:
          - type: string
          - type: 'null'
          title: Preview Status
        content:
          type: string
          title: Content
        scheduled_send_not_before:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Scheduled Send Not Before
      type: object
      required:
      - lead_id
      - sequence_id
      - message_id
      - step
      - preview_status
      - content
      - scheduled_send_not_before
      title: ActivationStartResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ChecklistItemOut:
      properties:
        key:
          type: string
          title: Key
        done:
          type: boolean
          title: Done
      type: object
      required:
      - key
      - done
      title: ChecklistItemOut
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer