> ## Documentation Index
> Fetch the complete documentation index at: https://offergrid.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Withdraw consent to be contacted

> Backs offergrid.io/opt-out. Marks every consent granted for this phone/email as revoked, unsubscribes the person with every team that knows them, and notifies the providers who were named. Always returns 200 — the response never reveals whether a number or address was known. Unauthenticated, rate-limited per IP.



## OpenAPI

````yaml /openapi/openapi-public.json post /public/consent/revoke
openapi: 3.0.0
info:
  title: OfferGrid API
  description: >-
    **Public API** - Unauthenticated endpoints with no API key required.


    These power two public, no-login surfaces:

    - **Shareable links** (`/public/links/*`) - a reseller-branded landing page
    for a specific set of offers, used to collect an order from an end customer.

    - **Consumer shop** (`/public/shop/*`) - the offergrid.io/shop storefront,
    where consumers browse real offers by ZIP code and either check out directly
    or are redirected to a provider's own site.


    All endpoints here are rate-limited and validate/re-check coverage
    server-side; none require the `x-api-key` header used by the Provider and
    Reseller APIs.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.offergrid.io
    description: Production
security: []
tags:
  - name: public
    description: >-
      Public: Unauthenticated endpoints for shareable links and the /shop
      storefront
paths:
  /public/consent/revoke:
    post:
      tags:
        - public
      summary: Withdraw consent to be contacted
      description: >-
        Backs offergrid.io/opt-out. Marks every consent granted for this
        phone/email as revoked, unsubscribes the person with every team that
        knows them, and notifies the providers who were named. Always returns
        200 — the response never reveals whether a number or address was known.
        Unauthenticated, rate-limited per IP.
      operationId: PublicConsentController_revoke
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RevokeConsentDto'
      responses:
        '200':
          description: Request recorded
        '400':
          description: Neither a phone nor an email was given
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected server error. Safe to retry idempotent requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    RevokeConsentDto:
      type: object
      properties:
        phone:
          type: string
          example: (512) 555-1234
          description: Any format; canonicalized to E.164.
        email:
          type: string
          example: jane@example.com
      title: Revoke Consent
    ValidationErrorResponse:
      type: object
      title: Validation Error
      description: >-
        Returned when request-body validation fails. `message` is an array with
        one entry per failed constraint.
      required:
        - statusCode
        - message
      properties:
        statusCode:
          type: integer
          example: 400
        message:
          type: array
          items:
            type: string
          description: One human-readable message per failed constraint.
          example:
            - name should not be empty
            - >-
              category must be one of the following values: internet,
              electricity
        error:
          type: string
          example: Bad Request
    ErrorResponse:
      type: object
      title: Error
      description: Standard error envelope returned by every 4xx and 5xx response.
      required:
        - statusCode
        - message
      properties:
        statusCode:
          type: integer
          description: HTTP status code, repeated in the body.
          example: 404
        message:
          type: string
          description: Human-readable explanation of what went wrong.
          example: Offer not found
        error:
          type: string
          description: Short, stable name for the status code.
          example: Not Found

````