Previews current eligible recipients for a draft without changing routing or audit.

POST

/api/workspace/file-protection/signal-recipients/preview

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/file-protection/signal-recipients/preview"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"Rules\": [ { \"PolicyKind\": 0, \"Severity\": 1, \"Recipients\": [ { \"Kind\": 0, \"Id\": \"example\", \"DisplayName\": \"example\" } ], \"EligibleRecipientCount\": 1 } ] }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/file-protection/signal-recipients/preview';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","Rules":[{"PolicyKind":0,"Severity":1,"Recipients":[{"Kind":0,"Id":"example","DisplayName":"example"}],"EligibleRecipientCount":1}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/file-protection/signal-recipients/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Rules": [ { "PolicyKind": 0, "Severity": 1, "Recipients": [ { "Kind": 0, "Id": "example", "DisplayName": "example" } ], "EligibleRecipientCount": 1 } ] }'

Authorizations

WorkspaceBearer

Parameters

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Atomically replaces all module recipient routing.

object

RowVersion

string format: uuid

Rules

Array<object>

nullable

Recipient selections for one type and level, with current workspace eligible audience count.

object

PolicyKind

integer format: int32

Allowed values: 0 1 2 3 4 5

Severity

integer format: int32

Allowed values: 1 2

Recipients

Array<object>

nullable

An explicit role or responsibility-group recipient selection.

object

Kind

integer format: int32

Allowed values: 0 1

string

nullable

DisplayName

string

nullable

EligibleRecipientCount

integer format: int32

Responses

200

application/json

object

Data

Module-wide delivery routing, independent from object rule enablement.

object

RowVersion

string format: uuid

Rules

Array<object>

nullable

Recipient selections for one type and level, with current workspace eligible audience count.

object

PolicyKind

integer format: int32

Allowed values: 0 1 2 3 4 5

Severity

integer format: int32

Allowed values: 1 2

Recipients

Array<object>

nullable

An explicit role or responsibility-group recipient selection.

object

Kind

integer format: int32

Allowed values: 0 1

string

nullable

DisplayName

string

nullable

EligibleRecipientCount

integer format: int32

AllowedActions

Array<string>

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Rules": [
      {
        "PolicyKind": 0,
        "Severity": 1,
        "Recipients": [
          {
            "Kind": 0
          }
        ]
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}