---
title: "Receive blocklist event"
method: POST
path: "receive-blocklist-event"
tags: ["platform", "blocklist"]
---

# Receive blocklist event

`POST receive-blocklist-event` (webhook)

Anytime a blocklist is added or removed by an end-user action or within the campaign, an event is sent. You need to subscribe to this event using the 'BLOCKLIST' channel, and specify the 'BLOCK' and 'UNBLOCK' events. For more details, see [documentation](https://www.infobip.com/docs/api/platform/subscriptions-api).

## Payload

- 2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33BlocklistEventRequest: Blocklist event request.
  - `results` 2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33BlocklistEvent[], required: Incoming blocklist events.
    - `event` 'BLOCK' | 'UNBLOCK', required: Blocklist event type.
    - `receivedAt` string, date-time, required: Date and time when the event was received.
    - `messageId` string, required: The ID that uniquely identifies the event sent.
    - `content` 2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33Content, required: Event content.
      - `sender` string: The sender ID for which blocklist happened.
      - `destination` string, required: Blocklisted destination address.
      - `channel` 'SMS' | 'EMAIL' | 'VOICE_OUTBOUND_TTS' | 'NEW_PUSH_NOTIF' | 'VIBER' | 'RCS' | 'WHATSAPP' | 'APPLE_MB' | 'MMS': Channel used for sending for which blocklist happened.
      - `sourceType` 'MO' | 'URL_OPT_OUT' | 'CAMPAIGN', required: Represents the way blocklist record was created: MO - blocklist record automatically created once an end user unsubscribes by replying with a specific keyword (e.g.: STOP). This is applicable for the following channels: SMS, MMS. URL_OPT_OUT - blocklist record automatically created once an end user clicks an opt-out link included in the message. CAMPAIGN - blocklist record automatically created through a triggered event in the Flow (e.g., if the message was not opened in 24h, add to blocklist).
      - `outboundMessageReference` 2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33OutboundMessageReference: Outbound message reference, if matched by the Infobip platform.
        - `bulkId` string: ID of the bulk of outgoing messages.
        - `outboundMessageId` string: ID of the paired outgoing message.
        - `sendAt` string, date-time: Date and time when the bulk or message was scheduled to be sent.
      - `inboundMessageReference` 2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33InboundMessageReference: Inbound message reference, if matched by the Infobip platform.
        - `inboundMessageId` string: ID of the message that triggered the event if matched by the Infobip platform. For example, MO message ID.
      - `campaignReference` 2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33CampaignReference: Campaign reference, if matched by the Infobip platform.
        - `campaignId` integer: ID of the campaign or flow.
        - `campaign` string: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
        - `versionId` integer: ID of the version of the campaign created over Infobip Portal.

## Acknowledgement `200`

Your server returns this code if it accepts the callback.

---

[API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)