FinanceGenius.AI CRM policy API

The CRM policy API from FinanceGenius.AI — 16 operation(s) for crm policy.

GitHub OpenAPI

Operations 17

GET /api/v1/crm/policy/templates/authored List Authored Templates #
POST /api/v1/crm/policy/templates/authored Create Authored Template #
POST /api/v1/crm/policy/templates/authored/check Check Authored Template #
POST /api/v1/crm/policy/templates/authored/{code}/{version}/withdraw Withdraw Authored Template #
GET /api/v1/crm/policy/templates List Templates #
GET /api/v1/crm/policy/templates/{code} Get Template #
POST /api/v1/crm/policy/templates/classify Classify Draft #
POST /api/v1/crm/policy/templates/sync Sync Templates #
POST /api/v1/crm/policy/templates/{code}/{language}/submit Submit #
POST /api/v1/crm/policy/templates/{code}/{language}/approve Approve #
POST /api/v1/crm/policy/templates/{code}/{language}/registrations Register With Provider #
GET /api/v1/crm/policy/journeys List Journeys #
GET /api/v1/crm/policy/campaigns List Campaigns #
POST /api/v1/crm/policy/check Dry Run #
GET /api/v1/crm/policy/suppressions/{customer_ref} List Suppressions #
POST /api/v1/crm/policy/suppressions Suppress #
POST /api/v1/crm/policy/suppressions/{suppression_id}/lift Lift #

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/financegenius-ai:financegenius-ai-crm-policy-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

financegenius-ai-crm-policy-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Financegenius Ai CRM policy API
  version: 1.0.0
  description: 'Operations tagged CRM policy across 2 of this provider''s published API definitions: finmall-openapi.json, financegenius-ai-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: CRM policy
paths:
  /api/v1/crm/policy/templates/authored:
    get:
      tags:
      - CRM policy
      summary: List Authored Templates
      operationId: list_authored_templates_api_v1_crm_policy_templates_authored_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response List Authored Templates Api V1 Crm Policy Templates Authored Get
    post:
      tags:
      - CRM policy
      summary: Create Authored Template
      description: 'Store a console-written template: it joins the registry as a draft, ready to submit for approval.'
      operationId: create_authored_template_api_v1_crm_policy_templates_authored_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthoredIn'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Create Authored Template Api V1 Crm Policy Templates Authored Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/crm/policy/templates/authored/check:
    post:
      tags:
      - CRM policy
      summary: Check Authored Template
      description: 'The builder''s live checks: the loader, R13 and the classifier on what would be stored. Writes nothing.'
      operationId: check_authored_template_api_v1_crm_policy_templates_authored_check_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthoredIn'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Check Authored Template Api V1 Crm Policy Templates Authored Check Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/crm/policy/templates/authored/{code}/{version}/withdraw:
    post:
      tags:
      - CRM policy
      summary: Withdraw Authored Template
      operationId: withdraw_authored_template_api_v1_crm_policy_templates_authored__code___version__withdraw_post
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
          title: Code
      - name: version
        in: path
        required: true
        schema:
          type: integer
          title: Version
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Withdraw Authored Template Api V1 Crm Policy Templates Authored  Code   Version  Withdraw Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/crm/policy/templates:
    get:
      tags:
      - CRM policy
      summary: List Templates
      operationId: list_templates_api_v1_crm_policy_templates_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response List Templates Api V1 Crm Policy Templates Get
  /api/v1/crm/policy/templates/{code}:
    get:
      tags:
      - CRM policy
      summary: Get Template
      operationId: get_template_api_v1_crm_policy_templates__code__get
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
          title: Code
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Template Api V1 Crm Policy Templates  Code  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/crm/policy/templates/classify:
    post:
      tags:
      - CRM policy
      summary: Classify Draft
      description: The console's live checks while drafting. Writes nothing.
      operationId: classify_draft_api_v1_crm_policy_templates_classify_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/app__api__v1__crm_policy__DraftIn'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Classify Draft Api V1 Crm Policy Templates Classify Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/crm/policy/templates/sync:
    post:
      tags:
      - CRM policy
      summary: Sync Templates
      operationId: sync_templates_api_v1_crm_policy_templates_sync_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Sync Templates Api V1 Crm Policy Templates Sync Post
  /api/v1/crm/policy/templates/{code}/{language}/submit:
    post:
      tags:
      - CRM policy
      summary: Submit
      operationId: submit_api_v1_crm_policy_templates__code___language__submit_post
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
          title: Code
      - name: language
        in: path
        required: true
        schema:
          type: string
          title: Language
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/app__api__v1__crm_policy__ReviewIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Submit Api V1 Crm Policy Templates  Code   Language  Submit Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/crm/policy/templates/{code}/{language}/approve:
    post:
      tags:
      - CRM policy
      summary: Approve
      operationId: approve_api_v1_crm_policy_templates__code___language__approve_post
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
          title: Code
      - name: language
        in: path
        required: true
        schema:
          type: string
          title: Language
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/app__api__v1__crm_policy__ReviewIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Approve Api V1 Crm Policy Templates  Code   Language  Approve Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/crm/policy/templates/{code}/{language}/registrations:
    post:
      tags:
      - CRM policy
      summary: Register With Provider
      operationId: register_with_provider_api_v1_crm_policy_templates__code___language__registrations_post
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
          title: Code
      - name: language
        in: path
        required: true
        schema:
          type: string
          title: Language
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegistrationIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Register With Provider Api V1 Crm Policy Templates  Code   Language  Registrations Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/crm/policy/journeys:
    get:
      tags:
      - CRM policy
      summary: List Journeys
      operationId: list_journeys_api_v1_crm_policy_journeys_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response List Journeys Api V1 Crm Policy Journeys Get
  /api/v1/crm/policy/campaigns:
    get:
      tags:
      - CRM policy
      summary: List Campaigns
      operationId: list_campaigns_api_v1_crm_policy_campaigns_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response List Campaigns Api V1 Crm Policy Campaigns Get
  /api/v1/crm/policy/check:
    post:
      tags:
      - CRM policy
      summary: Dry Run
      description: What the contact policy would say for this send now. Reads only; the transaction is rolled back.
      operationId: dry_run_api_v1_crm_policy_check_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/app__api__v1__crm_policy__CheckIn'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Dry Run Api V1 Crm Policy Check Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/crm/policy/suppressions/{customer_ref}:
    get:
      tags:
      - CRM policy
      summary: List Suppressions
      operationId: list_suppressions_api_v1_crm_policy_suppressions__customer_ref__get
      parameters:
      - name: customer_ref
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Customer Ref
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response List Suppressions Api V1 Crm Policy Suppressions  Customer Ref  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/crm/policy/suppressions:
    post:
      tags:
      - CRM policy
      summary: Suppress
      operationId: suppress_api_v1_crm_policy_suppressions_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuppressIn'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Suppress Api V1 Crm Policy Suppressions Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/crm/policy/suppressions/{suppression_id}/lift:
    post:
      tags:
      - CRM policy
      summary: Lift
      operationId: lift_api_v1_crm_policy_suppressions__suppression_id__lift_post
      parameters:
      - name: suppression_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Suppression Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LiftIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Lift Api V1 Crm Policy Suppressions  Suppression Id  Lift Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AuthoredText:
      properties:
        body:
          type: string
          maxLength: 1024
          title: Body
        email_subject:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Email Subject
        push_title:
          anyOf:
          - type: string
            maxLength: 65
          - type: 'null'
          title: Push Title
        push_body:
          anyOf:
          - type: string
            maxLength: 240
          - type: 'null'
          title: Push Body
      type: object
      required:
      - body
      title: AuthoredText
    AuthoredIn:
      properties:
        code:
          type: string
          pattern: ^[a-z][a-z0-9_]{1,63}$
          title: Code
        purpose:
          type: string
          title: Purpose
        category:
          type: string
          enum:
          - utility
          - marketing
          title: Category
        channels:
          items:
            type: string
            enum:
            - whatsapp
            - sms
            - email
            - push
          type: array
          maxItems: 4
          minItems: 1
          title: Channels
        variables:
          items:
            type: string
          type: array
          maxItems: 3
          title: Variables
        text:
          additionalProperties:
            $ref: '#/components/schemas/AuthoredText'
          type: object
          title: Text
        nudge_stage:
          anyOf:
          - type: string
          - type: 'null'
          title: Nudge Stage
      type: object
      required:
      - code
      - purpose
      - category
      - channels
      - text
      title: AuthoredIn
    SuppressIn:
      properties:
        customer_ref:
          type: string
          format: uuid
          title: Customer Ref
        reason:
          type: string
          enum:
          - customer_request
          - ops_request
          - dnd
          title: Reason
        channel:
          anyOf:
          - type: string
            enum:
            - whatsapp
            - sms
            - email
            - push
            - voice
            - in_app
          - type: 'null'
          title: Channel
        scope:
          type: string
          enum:
          - all
          - marketing
          title: Scope
          default: all
        days:
          anyOf:
          - type: integer
            maximum: 3650.0
            minimum: 1.0
          - type: 'null'
          title: Days
      type: object
      required:
      - customer_ref
      - reason
      title: SuppressIn
    app__api__v1__crm_policy__ReviewIn:
      properties:
        version:
          anyOf:
          - type: integer
            maximum: 1000.0
            minimum: 1.0
          - type: 'null'
          title: Version
      type: object
      title: ReviewIn
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    LiftIn:
      properties:
        lifted_by:
          type: string
          enum:
          - ops_request
          - customer_request
          - provider_resubscribed
          title: Lifted By
      type: object
      required:
      - lifted_by
      title: LiftIn
    app__api__v1__crm_policy__DraftIn:
      properties:
        code:
          type: string
          pattern: ^[a-z][a-z0-9_]{1,63}$
          title: Code
          default: draft
        purpose:
          type: string
          title: Purpose
        category:
          anyOf:
          - type: string
            enum:
            - utility
            - marketing
            - authentication
          - type: 'null'
          title: Category
        variables:
          items:
            type: string
          type: array
          maxItems: 10
          title: Variables
        text:
          additionalProperties:
            $ref: '#/components/schemas/DraftPart'
          type: object
          title: Text
      type: object
      required:
      - purpose
      - text
      title: DraftIn
    DraftPart:
      properties:
        body:
          type: string
          maxLength: 2000
          title: Body
        header:
          type: string
          maxLength: 200
          title: Header
          default: ''
        footer:
          type: string
          maxLength: 200
          title: Footer
          default: ''
        buttons:
          items:
            type: string
          type: array
          maxItems: 3
          title: Buttons
        email_subject:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Email Subject
        push_body:
          anyOf:
          - type: string
            maxLength: 300
          - type: 'null'
          title: Push Body
      type: object
      required:
      - body
      title: DraftPart
    RegistrationIn:
      properties:
        provider:
          type: string
          enum:
          - dlt
          - whatsapp
          title: Provider
        status:
          type: string
          enum:
          - pending
          - submitted
          - approved
          - rejected
          - paused
          - disabled
          - expired
          title: Status
        version:
          anyOf:
          - type: integer
            maximum: 1000.0
            minimum: 1.0
          - type: 'null'
          title: Version
        external_ref:
          anyOf:
          - type: string
            pattern: ^[A-Za-z0-9_.:-]{1,80}$
          - type: 'null'
          title: External Ref
        approved_on:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Approved On
        provider_category:
          anyOf:
          - type: string
            enum:
            - utility
            - marketing
            - authentication
          - type: 'null'
          title: Provider Category
      type: object
      required:
      - provider
      - status
      title: RegistrationIn
    app__api__v1__crm_policy__CheckIn:
      properties:
        customer_ref:
          type: string
          format: uuid
          title: Customer Ref
        purpose:
          type: string
          enum:
          - service_updates
          - credit_reminders
          - marketing
          title: Purpose
        channel:
          type: string
          enum:
          - whatsapp
          - sms
          - email
          - push
          - voice
          - in_app
          title: Channel
        template:
          type: string
          pattern: ^[a-z][a-z0-9_]{1,63}$
          title: Template
        language:
          type: string
          enum:
          - en
          - hi
          title: Language
          default: en
        version:
          anyOf:
          - type: integer
            maximum: 1000.0
            minimum: 1.0
          - type: 'null'
          title: Version
      type: object
      required:
      - customer_ref
      - purpose
      - channel
      - template
      title: CheckIn
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- finmall-openapi.json
- financegenius-ai-openapi.json
x-provenance:
  method: harvested
  publisher: FinanceGenius.AI
  source: https://api.finmall.ai/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)