MepMail Contact properties API

Custom fields stored on every contact.

GitHub OpenAPI

Operations 5

POST /contact-properties Create a contact property #
GET /contact-properties List contact properties #
GET /contact-properties/{id} Retrieve a contact property #
PATCH /contact-properties/{id} Update a contact property #
DELETE /contact-properties/{id} Delete a contact property #

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/mepmail-dev:mepmail-dev-contact-properties-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

mepmail-dev-contact-properties-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Mepmail Dev Contact properties API
  version: 1.0.0
  description: 'Operations tagged Contact properties across 2 of this provider''s published API definitions: docs.json, mepmail-dev-docs-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.mepmail.dev
  description: MepMail Cloud
- url: '{baseUrl}'
  description: Self-hosted instance
  variables:
    baseUrl:
      default: http://localhost:3001
security:
- apiKey: []
tags:
- name: Contact properties
  description: Custom fields stored on every contact.
paths:
  /contact-properties:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateContactPropertyRequest'
            example:
              key: plan
              type: string
              fallback_value: free
      responses:
        '200':
          description: Contact property created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetContactPropertyResponse'
              example:
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                created_at: '2026-10-19T12:00:00.000Z'
                key: plan
                type: string
                fallback_value: fallback value
                object: contact_property
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Property already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: createContactProperty
      summary: Create a contact property
      tags:
      - Contact properties
      description: Defines a custom field that every contact can carry.
    get:
      parameters:
      - schema:
          type: integer
          minimum: 1
          maximum: 100
          description: Page size, 1-100 (default 20)
        required: false
        description: Page size, 1-100 (default 20)
        name: limit
        in: query
      - schema:
          type: string
          format: uuid
          description: 'Cursor: id of the last item of the previous page. Must be an id this list returned; there is no sentinel value.'
        required: false
        description: 'Cursor: id of the last item of the previous page. Must be an id this list returned; there is no sentinel value.'
        name: after
        in: query
      - schema:
          type: string
          format: uuid
          description: 'Cursor: id of the first item of the next page (page backwards); same rule as after.'
        required: false
        description: 'Cursor: id of the first item of the next page (page backwards); same rule as after.'
        name: before
        in: query
      responses:
        '200':
          description: Contact properties
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListContactPropertiesResponse'
              example:
                object: list
                data:
                - id: 4ef9a417-02e9-4d39-ad75-9611e0fcc33c
                  created_at: '2026-10-19T12:00:00.000Z'
                  key: plan
                  type: string
                  fallback_value: fallback value
                has_more: false
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: listContactProperties
      summary: List contact properties
      tags:
      - Contact properties
      description: Lists the team's custom contact fields.
    servers:
    - url: https://api.mepmail.dev
      description: MepMail Cloud
    - url: '{baseUrl}'
      description: Self-hosted instance
      variables:
        baseUrl:
          default: http://localhost:3001
  /contact-properties/{id}:
    get:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Contact property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetContactPropertyResponse'
              example:
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                created_at: '2026-10-19T12:00:00.000Z'
                key: plan
                type: string
                fallback_value: fallback value
                object: contact_property
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: getContactProperty
      summary: Retrieve a contact property
      tags:
      - Contact properties
      description: Returns one custom contact field.
    patch:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContactPropertyRequest'
            example:
              fallback_value: trial
      responses:
        '200':
          description: Contact property updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactPropertyIdResponse'
              example:
                object: contact_property
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: updateContactProperty
      summary: Update a contact property
      tags:
      - Contact properties
      description: Renames a custom contact field or changes its fallback value.
    delete:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Contact property deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveContactPropertyResponse'
              example:
                object: contact_property
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                deleted: true
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: deleteContactProperty
      summary: Delete a contact property
      tags:
      - Contact properties
      description: Deletes a custom contact field and its values.
    servers:
    - url: https://api.mepmail.dev
      description: MepMail Cloud
    - url: '{baseUrl}'
      description: Self-hosted instance
      variables:
        baseUrl:
          default: http://localhost:3001
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
        name:
          type: string
        message:
          type: string
      required:
      - statusCode
      - name
      - message
    ContactPropertyIdResponse:
      type: object
      properties:
        object:
          type: string
          enum:
          - contact_property
        id:
          type: string
          format: uuid
      required:
      - object
      - id
    UpdateContactPropertyRequest:
      type: object
      properties:
        fallback_value:
          anyOf:
          - type: string
            maxLength: 1000
          - type: number
          - type: 'null'
    RemoveContactPropertyResponse:
      type: object
      properties:
        object:
          type: string
          enum:
          - contact_property
        id:
          type: string
          format: uuid
        deleted:
          type: boolean
          enum:
          - true
      required:
      - object
      - id
      - deleted
    CreateContactPropertyRequest:
      type: object
      properties:
        key:
          type: string
          minLength: 1
          maxLength: 200
        type:
          type: string
          enum:
          - string
          - number
        fallback_value:
          anyOf:
          - type: string
            maxLength: 1000
          - type: number
          - type: 'null'
      required:
      - key
      - type
    GetContactPropertyResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        created_at:
          type: string
        key:
          type: string
        type:
          type: string
          enum:
          - string
          - number
        fallback_value:
          anyOf:
          - type: string
          - type: number
          - type: 'null'
        object:
          type: string
          enum:
          - contact_property
      required:
      - id
      - created_at
      - key
      - type
      - fallback_value
      - object
    ListContactPropertiesResponse:
      type: object
      properties:
        object:
          type: string
          enum:
          - list
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              created_at:
                type: string
              key:
                type: string
              type:
                type: string
                enum:
                - string
                - number
              fallback_value:
                anyOf:
                - type: string
                - type: number
                - type: 'null'
            required:
            - id
            - created_at
            - key
            - type
            - fallback_value
        has_more:
          type: boolean
      required:
      - object
      - data
      - has_more
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An API key from the dashboard (ms_…), sent as Authorization: Bearer. A sending-only key reaches the /emails routes only.'
x-refined-from:
- docs.json
- mepmail-dev-docs-openapi.json
x-provenance:
  method: harvested
  publisher: MepMail
  source: https://docs.mepmail.dev/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)