Applied groups

PreviousExport NextDestroy

Was this helpful?

List applied groups of outbound rule

Retrieve a collection of user groups applied to outbound rule.

get

/outbound_rules/{id}/applied_groups

Authorizations

Path parameters

idall ofrequired

The unique ID of outbound rule.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/outbound_rules/{id}/applied_groups' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "items": [
    {
      "name": "text",
      "description": "text",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}

Check if a group has outbound rule applied

Check if a group has outbound rule applied.

get

/outbound_rules/{id}/applied_groups/{group_id}

Authorizations

Path parameters

idall ofrequired

The unique ID of outbound rule.

group_idall ofrequired

The unique ID of user group.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/outbound_rules/{id}/applied_groups/{group_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

{
  "name": "text",
  "description": "text",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Apply group to outbound rule

Apply a group to outbound rule.

post

/outbound_rules/{id}/applied_groups/{group_id}

Authorizations

Path parameters

idall ofrequired

The unique ID of outbound rule.

group_idall ofrequired

The unique ID of user group.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/outbound_rules/{id}/applied_groups/{group_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

No body