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

# Delete an opt-out

> Removes a phone number from your opt-out list for one channel, so you can message it again on that channel. Do this only after the contact has given consent again, for example after they reply `START`.



## OpenAPI

````yaml openapi-sms.yaml DELETE /opt-outs/{phoneNumber}
openapi: 3.0.3
info:
  title: Vobiz Messaging API
  description: >
    Send and receive SMS, MMS and RCS messages, buy messaging numbers, register
    for

    US 10DLC and toll-free, run broadcasts, manage conversations, opt-outs and
    webhooks.


    **Base URL:** `https://api.vobiz.ai/api/v1/sms`


    **Authentication:** every request needs the `X-Auth-ID` and `X-Auth-Token`
    headers.

    The account is taken from your credentials; you never put an account ID in a
    path or body.

    Field names in this API are camelCase.
  version: '1.0'
  contact:
    email: support@vobiz.ai
    url: https://vobiz.ai
servers:
  - url: https://api.vobiz.ai/api/v1/sms
    description: Production
security:
  - AuthID: []
    AuthToken: []
tags:
  - name: Messages
    description: Send messages and inspect their delivery state.
  - name: Numbers
    description: >-
      Messaging-capable numbers on your account, inventory search, purchase and
      release.
  - name: Coverage
    description: Where you can send, per country.
  - name: Conversations
    description: Two-way threads between one of your numbers and a contact.
  - name: Opt-outs
    description: Numbers that must not receive messages on a channel.
  - name: Webhooks
    description: Subscriptions that deliver message and broadcast events to your server.
  - name: Broadcasts
    description: Bulk sends from an uploaded recipient list.
  - name: RCS Senders
    description: RCS sender (agent) identities and their message templates.
  - name: 10DLC Brands
    description: US 10DLC brand registration.
  - name: 10DLC Campaigns
    description: US 10DLC campaigns, toll-free verification and supporting documents.
paths:
  /opt-outs/{phoneNumber}:
    delete:
      tags:
        - Opt-outs
      summary: Delete an opt-out
      description: >-
        Removes a phone number from your opt-out list for one channel, so you
        can message it again on that channel. Do this only after the contact has
        given consent again, for example after they reply `START`. The response
        is `200` whether or not a record existed, so it is safe to retry.
        Removing an opt-out on one channel leaves entries on other channels in
        place; delete each one separately.
      operationId: delete-opt-out
      parameters:
        - name: phoneNumber
          in: path
          required: true
          description: >-
            The number in E.164 format, for example `+14155550123`. In raw HTTP
            requests, URL-encode the `+` as `%2B` (`/opt-outs/%2B14155550123`);
            the SDKs encode it for you.
          schema:
            type: string
          example: '+14155550123'
        - name: channel
          in: query
          description: >-
            Channel to remove the opt-out from: `sms`, `mms` or `rcs`. Defaults
            to `sms`.
          schema:
            type: string
            default: sms
          example: sms
      responses:
        '200':
          description: The number is unblocked on that channel.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusOk'
              example:
                status: ok
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
        - lang: typescript
          label: Node SDK
          source: >
            import { VobizClient } from "@vobiz/sdk";


            const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken:
            "YOUR_AUTH_TOKEN" });


            await client.sms.optOuts.deleteOptOut({
                phoneNumber: "+14155550123",
                channel: "sms"
            })
        - lang: python
          label: Python SDK
          source: |
            from vobiz import Vobiz

            client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")

            client.sms.opt_outs.delete_opt_out(
                phone_number="+14155550123",
                channel="sms",
            )
        - lang: go
          label: Go SDK
          source: |
            import (
                "context"

                vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
                "github.com/vobiz-ai/Vobiz-Go-SDK/client"
                "github.com/vobiz-ai/Vobiz-Go-SDK/option"
                "github.com/vobiz-ai/Vobiz-Go-SDK/sms"
            )

            c := client.NewClient(
                option.WithAPIKey("MA_XXXXXXXX"),
                option.WithAuthToken("YOUR_AUTH_TOKEN"),
            )

            request := &sms.DeleteOptOutRequest{
                    PhoneNumber: "+14155550123",
                    Channel: vobiz.String(
                        "sms",
                    ),
                }
            c.Sms.OptOuts.DeleteOptOut(
                    context.TODO(),
                    request,
                )
        - lang: java
          label: Java SDK
          source: |
            import com.vobiz.api.VobizApiClient;

            VobizApiClient client = VobizApiClient
                .builder()
                .apiKey("MA_XXXXXXXX")
                .authToken("YOUR_AUTH_TOKEN")
                .build();

            client.sms().optOuts().deleteOptOut(
                "+14155550123",
                DeleteOptOutRequest
                    .builder()
                    .channel("sms")
                    .build()
            );
        - lang: ruby
          label: Ruby SDK
          source: >
            require 'vobiz'


            client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token:
            'YOUR_AUTH_TOKEN')


            client.sms.opt_outs.delete_opt_out(
              phone_number: "+14155550123",
              channel: "sms"
            )
        - lang: csharp
          label: C# SDK
          source: |
            using Vobiz;
            using Vobiz.Sms;

            var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");

            await client.Sms.OptOuts.DeleteOptOutAsync(
                new DeleteOptOutRequest { PhoneNumber = "+14155550123", Channel = "sms" }
            );
        - lang: php
          label: PHP SDK
          source: >
            <?php


            require 'vendor/autoload.php';


            use Vobiz\VobizClient;


            $client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken:
            'YOUR_AUTH_TOKEN');


            $client->sms->optOuts->deleteOptOut(
                '+14155550123',
                new DeleteOptOutRequest([
                    'channel' => 'sms',
                ]),
            );
components:
  schemas:
    StatusOk:
      type: object
      properties:
        status:
          type: string
          example: ok
          description: Always `ok` when the action succeeded.
      description: >-
        Confirmation returned by actions that have no resource to return, such
        as marking a conversation read or creating or deleting an opt-out.
    Error:
      type: object
      description: >-
        The body of every error response: a flat object with one `error` string
        that explains what went wrong. Use the HTTP status code to decide how to
        handle the error, and log `error` for diagnosis.
      required:
        - error
      properties:
        error:
          type: string
          example: 'recipient has opted out: +14155550123'
          description: >-
            Human-readable explanation of the error, for example `phoneNumber is
            required` or `recipient has opted out: +14155550123`. Branch on the
            HTTP status code rather than on this text.
  responses:
    Unauthorized:
      description: Missing or invalid `X-Auth-ID` / `X-Auth-Token`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: missing or invalid credentials
    ServerError:
      description: Unexpected error. Retry with the same idempotency key where one applies.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: internal error
  securitySchemes:
    AuthID:
      type: apiKey
      in: header
      name: X-Auth-ID
      description: Your Vobiz account Auth ID (`MA_XXXXXXXX`).
    AuthToken:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Your Vobiz account Auth Token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.