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

# Set Delivery Status

> Set or change the delivery status on an outgoing messsage.

NsApiSlow threshold: 5000 ms.
<para />## Online Restricted: ## The Messaging agent is not available in Online by default. Access must be requested specifically when app is registered.



## OpenAPI

````yaml /openapi/agent/openapi-v3-MessagingAgent.json post /api/v1/Agents/Messaging/SetDeliveryStatus
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - MessagingAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/Messaging/SetDeliveryStatus:
    post:
      tags:
        - Messaging_Agent
      summary: Set Delivery Status
      description: "Set or change the delivery status on an outgoing messsage.\n\nNsApiSlow threshold: 5000 ms.\r\n<para />## Online Restricted: ## The Messaging agent is not available in Online by default. Access must be requested specifically when app is registered."
      operationId: v1MessagingAgent_SetDeliveryStatus
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MessagingCarriers.SetDeliveryStatusRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MessagingCarriers.SetDeliveryStatusRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MessagingCarriers.SetDeliveryStatusRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MessagingCarriers.SetDeliveryStatusRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MessagingCarriers.SetDeliveryStatusRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MessagingCarriers.SetDeliveryStatusRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MessagingCarriers.SetDeliveryStatusRequest
        description: Plugin, ExternalMessageId, Status, StatusDescription
        required: true
      responses:
        '204':
          description: No Content
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.MessagingCarriers.SetDeliveryStatusRequest:
      description: >-
        SetDeliveryStatus: Set or change the delivery status on an outgoing
        messsage.
      type: object
      properties:
        Plugin:
          type: string
        ExternalMessageId:
          type: string
        Status:
          format: int32
          type: integer
        StatusDescription:
          type: string

````

## Related topics

- [SuperOffice.WebApi.Data.Messaging SetDeliveryStatusRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Messaging_SetDeliveryStatusRequest.md)
- [NSMessagingAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSMessagingAgent.md)
- [SuperOffice.WebApi.Agents.IMessagingAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IMessagingAgent.md)
- [SuperOffice.WebApi.Agents.MessagingAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.MessagingAgent.md)
- [NSMessageDeliveryStatus](/en/automation/crmscript/reference/CRMScript.NetServer.NSMessageDeliveryStatus.md)
- [Get Delivery Status](/en/api/reference/restful/agent/messaging_agent/get-delivery-status.md)