CrossEngage

CrossEngage Opt-out management API

The Opt-out management API from CrossEngage — 3 operation(s) for opt-out management.

GitHub OpenAPI

Operations 5

GET /users/{id}/recipient-status Get a user's status #
PUT /users/{id}/optout-status Update a user's opt out status #
GET /users/{id}/optout-status Read a user's opt out status #
PUT /users/{id}/blacklist-status Update a user's blacklist status #
GET /users/{id}/blacklist-status Read a user's blacklist status #

Documentation

📖
APIReference
https://usermanagementv2.docs.apiary.io/
📖
Documentation
https://api.documentation.crossengage.io/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/crossenagage/refs/heads/main/authentication/crossenagage-authentication.yml
📖
APIReference
https://usermanagementv1.docs.apiary.io/
📖
APIReference
https://productfeedapiv1.docs.apiary.io/
📖
APIReference
https://userseventsexportapiv1.docs.apiary.io/
📖
APIReference
https://statisticsapi1.docs.apiary.io/
📖
APIReference
https://fileattachmentsv1.docs.apiary.io/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/crossenagage/refs/heads/main/openapi/crossenagage-opt-out-management-api-openapi.yml

Other Resources

🔗
APIBlueprint
https://raw.githubusercontent.com/api-evangelist/crossenagage/refs/heads/main/blueprint/crossenagage-user-management-v2.apib
🔗
APIBlueprint
https://raw.githubusercontent.com/api-evangelist/crossenagage/refs/heads/main/blueprint/crossenagage-user-management-v1.apib
🔗
APIBlueprint
https://raw.githubusercontent.com/api-evangelist/crossenagage/refs/heads/main/blueprint/crossenagage-raw-export-v1.apib
🔗
APIBlueprint
https://raw.githubusercontent.com/api-evangelist/crossenagage/refs/heads/main/blueprint/crossenagage-statistics-v1.apib
🔗
APIBlueprint
https://raw.githubusercontent.com/api-evangelist/crossenagage/refs/heads/main/blueprint/crossenagage-file-attachments-v1.apib

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/crossenagage-opt-out-management-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.

GitHub Google LinkedIn

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

OpenAPI Specification

crossenagage-opt-out-management-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: User Management API V1 Opt-out management API
  version: ''
  description: The host of all of the URLs defined in this documentation is `https://api.documentation.crossengage.io`.
servers:
- url: https://api.crossengage.io/
tags:
- name: Opt-Out Management
paths:
  /users/{id}/recipient-status:
    get:
      responses:
        '200':
          description: Example server response
          headers: {}
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  blacklisted:
                    type: boolean
                  optOutAll:
                    type: boolean
                  optOutChannels:
                    type: array
                    items: {}
                example:
                  blacklisted: false
                  optOutAll: false
                  optOutChannels: []
              example:
                blacklisted: false
                optOutAll: false
                optOutChannels: []
        '401':
          description: Wrong or missing credentials
          headers: {}
          content: {}
        '500':
          description: Unknown error on our side
          headers: {}
          content: {}
      summary: Get a user's status
      operationId: Get a user's status
      description: Check the overall status of a particular user.
      tags:
      - Opt-Out Management
      parameters:
      - name: id
        in: path
        description: The id of the user in your database
        required: true
        x-example: 78ad0e3e-19e6-4ec1-84a7-b2c860c05387
        schema:
          type: string
      - name: X-XNG-ApiVersion
        in: header
        description: e.g. 1
        required: false
        x-example: '1'
        schema:
          type: string
      - name: X-XNG-AuthToken
        in: header
        description: e.g. Your API Key
        required: false
        x-example: Your API Key
        schema:
          type: string
  /users/{id}/optout-status:
    put:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  optOut:
                    type: boolean
                example:
                  optOut: true
              example:
                optOut: true
        '401':
          description: Wrong or missing credentials
          headers: {}
          content: {}
        '404':
          description: This user does not exist
          headers: {}
          content: {}
        '500':
          description: Unknown error on our side
          headers: {}
          content: {}
      summary: Update a user's opt out status
      operationId: Update a user's opt out status
      description: Update a specific user's overall opt out status or for a specific channel.
      tags:
      - Opt-Out Management
      parameters:
      - name: id
        in: path
        description: The id of the user in your database
        required: true
        x-example: 78ad0e3e-19e6-4ec1-84a7-b2c860c05387
        schema:
          type: string
      - name: channelType
        in: query
        description: The specific channel you'd like to update
        required: false
        x-example: MAIL
        schema:
          type: string
      - name: X-XNG-ApiVersion
        in: header
        description: e.g. 1
        required: false
        x-example: '1'
        schema:
          type: string
      - name: X-XNG-AuthToken
        in: header
        description: e.g. Your API Key
        required: false
        x-example: Your API Key
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                optOut:
                  type: boolean
              example:
                optOut: true
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  optOut:
                    type: boolean
                example:
                  optOut: true
              example:
                optOut: true
        '401':
          description: Wrong or missing credentials
          headers: {}
          content: {}
        '404':
          description: This user does not exist
          headers: {}
          content: {}
        '500':
          description: Unknown error on our side
          headers: {}
          content: {}
      summary: Read a user's opt out status
      operationId: Read a user's opt out status
      description: Read a specific user's overall opt out status or for a specific channel.
      tags:
      - Opt-Out Management
      parameters:
      - name: id
        in: path
        description: The id of the user in your database
        required: true
        x-example: 78ad0e3e-19e6-4ec1-84a7-b2c860c05387
        schema:
          type: string
      - name: channelType
        in: query
        description: The specific channel you'd like to update
        required: false
        x-example: MAIL
        schema:
          type: string
      - name: X-XNG-ApiVersion
        in: header
        description: e.g. 1
        required: false
        x-example: '1'
        schema:
          type: string
      - name: X-XNG-AuthToken
        in: header
        description: e.g. Your API Key
        required: false
        x-example: Your API Key
        schema:
          type: string
  /users/{id}/blacklist-status:
    put:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  blacklisted:
                    type: boolean
                example:
                  blacklisted: true
              example:
                blacklisted: true
        '401':
          description: Wrong or missing credentials
          headers: {}
          content: {}
        '404':
          description: This user does not exist
          headers: {}
          content: {}
        '500':
          description: Unknown error on our side
          headers: {}
          content: {}
      summary: Update a user's blacklist status
      operationId: Update a user's blacklist status
      description: ''
      tags:
      - Opt-Out Management
      parameters:
      - name: id
        in: path
        description: The id of the user in your database
        required: true
        x-example: 78ad0e3e-19e6-4ec1-84a7-b2c860c05387
        schema:
          type: string
      - name: X-XNG-ApiVersion
        in: header
        description: e.g. 1
        required: false
        x-example: '1'
        schema:
          type: string
      - name: X-XNG-AuthToken
        in: header
        description: e.g. Your API Key
        required: false
        x-example: Your API Key
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                blacklisted:
                  type: boolean
              example:
                blacklisted: true
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  blacklisted:
                    type: boolean
                example:
                  blacklisted: true
              example:
                blacklisted: true
        '401':
          description: Wrong or missing credentials
          headers: {}
          content: {}
        '404':
          description: This user does not exist
          headers: {}
          content: {}
        '500':
          description: Unknown error on our side
          headers: {}
          content: {}
      summary: Read a user's blacklist status
      operationId: Read a user's blacklist status
      description: ''
      tags:
      - Opt-Out Management
      parameters:
      - name: id
        in: path
        description: The id of the user in your database
        required: true
        x-example: 78ad0e3e-19e6-4ec1-84a7-b2c860c05387
        schema:
          type: string
      - name: X-XNG-ApiVersion
        in: header
        description: e.g. 1
        required: false
        x-example: '1'
        schema:
          type: string
      - name: X-XNG-AuthToken
        in: header
        description: e.g. Your API Key
        required: false
        x-example: Your API Key
        schema:
          type: string