Mensaje: Cancelar suscripción

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Envía una solicitud por correo electrónico en nombre del usuario que ha iniciado sesión para cancelar la suscripción de una lista de distribución de correo electrónico. Usa la información del List-Unsubscribe encabezado.

Los remitentes de mensajes pueden usar las listas de distribución de correo de una manera fácil de usar al incluir una opción para que los destinatarios opten por no participar. Para ello, especifiquen el List-Unsubscribe encabezado en cada mensaje siguiendo RFC-2369.

Nota En concreto, para que la acción de cancelar la suscripción funcione, el remitente debe especificar mailto: información de cancelación de suscripción basada en URL y no en ella basada en URL.

Al establecer ese encabezado, también se establecería la propiedad unsubscribeEnabled de la instancia del mensaje en true, y la propiedad unsubscribeData en los datos del encabezado .

Si la propiedad unsubscribeEnabled de un mensaje es true, puede utilizar la acción de cancelar la suscripción para cancelar la suscripción del usuario de mensajes futuros similares administrados por el remitente del mensaje.

Una acción de cancelar la suscripción correcta mueve el mensaje a la carpeta Elementos eliminados . El remitente administra la exclusión real del usuario de la distribución de correo futura.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global	Administración pública de EE. UU.	Gobierno de EE. UU. L5 (DOD)	China operado por 21Vianet
✅	✅	✅	✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	Mail.Send	No disponible.
Delegado (cuenta personal de Microsoft)	Mail.Send	No disponible.
Aplicación	Mail.Send	No disponible.

Solicitud HTTP

POST /users/{id | userPrincipalName}/messages/{id}/unsubscribe

Encabezados de solicitud

Nombre	Tipo	Descripción
Authorization	string	{token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización.

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se ejecuta correctamente, este método devuelve el código de respuesta 202 Accepted. No devuelve nada en el cuerpo de la respuesta.

Ejemplo

En el siguiente ejemplo se muestra cómo llamar a esta API.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

POST https://graph.microsoft.com/beta/me/messages/{id}/unsubscribe


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Me.Messages["{message-id}"].Unsubscribe.PostAsync();

Importante

Los SDK de Microsoft Graph usan la versión v1.0 de la API de manera predeterminada y no admiten todos los tipos, propiedades y API disponibles en la versión beta. Para obtener más información sobre cómo acceder a la API beta con el SDK, consulte Uso de los SDK de Microsoft Graph con la API beta.

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Me().Messages().ByMessageId("message-id").Unsubscribe().Post(context.Background(), nil)

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.me().messages().byMessageId("{message-id}").unsubscribe().post();

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/me/messages/{id}/unsubscribe')
	.version('beta')
	.post();

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->me()->messages()->byMessageId('message-id')->unsubscribe()->post()->wait();

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


Import-Module Microsoft.Graph.Beta.Mail

# A UPN can also be used as -UserId.
Invoke-MgBetaUnsubscribeUserMessage -UserId $userId -MessageId $messageId

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.me.messages.by_message_id('message-id').unsubscribe.post()

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 202 Accepted

Comentarios

¿Le ha resultado útil esta página?

Last updated on 2026-08-18

Mensaje: Cancelar suscripción

Permissions

Solicitud HTTP

Encabezados de solicitud

Cuerpo de la solicitud

Respuesta

Ejemplo

Solicitud

Respuesta

Comentarios

Recursos adicionales