Versions Compared

Old Version 6

changes.mady.by.user Juan Tomás Alonso Nieto

Saved on

compared with

New Version Current

changes.mady.by.user Borja Moro Moreno

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel2
maxLevel2
outlinefalse
typeflat
separatorbrackets
printabletrue

Overview

Check the list of available endpoints and methods to work with sending policies using the Delivery methods API:

...

Endpoints and methods

...

Description

...

Status
colourYellow
titleGET
 /policies see below

Table of Contents
minLevel2
maxLevel2
outlinefalse
typeflat
separatorbrackets
printabletrue

Overview

Check the list of available endpoints and methods to work with sending policies using the Delivery methods API:

Endpoints and methods

Description

Status
colourYellow
titleGET
 /policies see below

Lists the available sending policies in the domain.

Status
colourYellow
titleGET
 /policy/{id} see below

Gets a detailed description of a specific sending policy.

Status
colourGreen
titlePOST
/policies see below

Creates a new sending policy.

Status
colourBlue
titlePUT
/policies see below

Edits a sending policy.

Status
colourRed
titleDELETE
/policies/{id} see below

Deletes a sending policy.

Endpoints and methods

Anchor
tag1
tag1
GET/policies

Retrieves a list of the sending policies in the domain.

...

Expand
titleResponse

Check the list of available responses:

Code

Description

200

Successful response. Available sending policies retrieved.

Code Block
[
  {
    "id": 284,
    "name": "default-delivery",
    "isDefault": true,
    "scheduled": {
      "days": [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY",
        "SATURDAY",
        "SUNDAY"
      ],
      "from": "00:00",
      "to": "23:59"
    },
    "deliveryMethods": [
      {
        "id": 331,
        "type": "email",
        "name": "default-email"
      }
    ],
    "antiFloodingPolicy": {
      "id": 267,
      "name": "default AF"
    }
  },
  {
    "id": 1275,
    "name": "mySendingPolicy",
    "isDefault": false,
    "scheduled": {
      "days": [
        "TUESDAY",
        "THURSDAY"
      ],
      "from": "09:30",
      "to": "18:30"
    },
    "deliveryMethods": [
      {
        "id": 331,
        "type": "email",
        "name": "default-email"
      }
    ],
    "antiFloodingPolicy": {
      "id": 267,
      "name": "default AF"
    }
  },
  {
    "id": 467,
    "name": "Workweek - Support Hours",
    "isDefault": false,
    "scheduled": {
      "days": [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY"
      ],
      "from": "08:00",
      "to": "20:00"
    },
    "deliveryMethods": [
      {
        "id": 331,
        "type": "email",
        "name": "default-email"
      }
    ],
    "antiFloodingPolicy": null
  }
]

400

Request error.

Code Block
{
  "code": 400,
  "msg": "string",
  "cid": "string"
}

403

Authentication required.

Code Block
{
  "code": 403,
  "msg": "string",
  "cid": "string"
}

Anchor
tag2
tag2
GET/policy/{id}

Gets a detailed description of a specific sending policy given its ID.

curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/delco/policies/123"

delivery methods in the domain that corresponds to the given token. Learn how to authorize your request in this article.

Expand
titleRequest

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Definition

id required

integer

ID of the sending policy you want to retrieve.

Note

How can I get the ID of a sending policy

You can use the GET/policies endpoint to get the IDs of the sending policies defined in your domain.

Example

Find below a request example in cURL language. This request will retrieve all the email type delivery methods in the domain that corresponds to the given token. Learn how to authorize your request in this article.

Code Block
Code Block
curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/delco/policies/123"
Expand
titleResponse

Check the list of available responses:

Code

Description

200

Successful response. Details of the sending policy retrieved.

Code Block
{
  "id": 123,
  "name": "default-delivery",
  "isDefault": true,
  "scheduled": {
    "days": [
      "MONDAY",
      "TUESDAY",
      "WEDNESDAY",
      "THURSDAY",
      "FRIDAY",
      "SATURDAY",
      "SUNDAY"
    ],
    "from": "00:00",
    "to": "23:59"
  },
  "deliveryMethods": [
    {
      "id": 331,
      "type": "email",
      "name": "default-email"
    }
  ],
  "antiFloodingPolicy": {
    "id": 267,
    "name": "default AF"
  }
}

400

Request error.

Code Block
{
  "code": 400,
  "msg": "string",
  "cid": "string"
}

403

Authentication required.

Code Block
{
  "code": 403,
  "msg": "string",
  "cid": "string"
}

Anchor
tag3
tag3
POST/policies

Creates a new sending policy.

Expand
titleRequest

Request body

You must specify the updates you need to apply to the delivery method in the request body:

Parameter

Type

Definition

name required

string

Name of the new sending policy.

deliveryMethods required

object

Recipient of the alert, which corresponds to a delivery method created in the domain.

Define an object with the following parameters:

  • type (string) - Type of the delivery method to associate this policy with. Valid values are:

    • email

    • httpjson

    • servicedesk

    • jira

    • pushover

    • pagerduty

    • slack

    • servicenow

  • name (string) - Name of the delivery method to associate this policy with.

Note

Note that both the delivery method type and name must exist in the corresponding domain. Otherwise, the request won’t work.

Example

Code Block
"deliveryMethods": [
  "type": "email",
  "name": "my-delivery-method"
]

Visit Create and manage delivery methods to know more.

isDefault

boolean

If you set this to true, this policy will be automatically assigned to new alerts and predefined alerts that have not actively been assigned a sending policy.

antiFloodingPolicy

Frequency limit established for persistent alerts. You can choose between none, default, or one of your own creation.

Visit Create and manage delivery methods to know more.

scheduled

object

Days and hours during which alerts should be distributed. The time zone defined in the delivery method(s) selected is used to calculate times.

Define an object with the following parameters:

  • days (string) - Enter the weekdays you want the alert to be distributed. Indicate the specific days between brackets []. For example:

Code Block
"days": [
    "MONDAY",
    "TUESDAY",
    "WEDNESDAY",
    "THURSDAY",
    "FRIDAY",
    "SATURDAY",
    "SUNDAY"
],

  • from - Indicate the starting time for alerts to be sent.

  • to -

Example

Code Block
"scheduled": {
    "days": [
        "TUESDAY",
        "THURSDAY"
    ],
    "from": "00:00",
    "to": "23:59"
},
Expand
titleResponse

Check the list of available responses:

Code

Description

200

Successful response.

Details of the sending policy retrieved

Sending policy created.

Code Block
{
  "id": 123,
  "name": "default-delivery",
  "isDefault": true,
  "scheduled": {
    "days": [
      "MONDAY",
      "TUESDAY",
      "WEDNESDAY",
      "THURSDAY",
      "FRIDAY",
      "SATURDAY",
      "SUNDAY"
    ],
    "from": "00:00",
    "to": "23:59"
  },
  "deliveryMethods": [
    {
      "id": 331,
      "type": "email",
      "name": "default-email"
    }
  ],
  "antiFloodingPolicy": {
    "id": 267,
    "name": "default AF"
  }
}

400

Request error.

Code Block
{
  "code": 400,
  "msg": "string",
  "cid": "string"
}

403

Authentication required.

Code Block
{
  "code": 403,
  "msg": "string",
"cid": "string" }

...

Creates a new sending policy.

Recipient of the alert.

Define an object with the following parameters:

  • id - Enter the ID of the

  • type -

  • name -

Example

code
Expand
titleRequest

Request body

You must specify the updates you need to apply to the delivery method in the request body:

Parameter

Type

Definition

name required

string

Name of the new sending policy.

deliveryMethods required

object


  "cid": "string"
}

Anchor
tag4
tag4
PUT/policies

Edits an existing sending policy.

Expand
titleRequest

Request body

You must specify the updates you need to apply to the delivery method in the request body:

Parameter

Type

Definition

name required

string

Name of the new sending policy.

deliveryMethods required

object

Recipient of the alert, which corresponds to a delivery method created in the domain.

Define an object with the following parameters:

  • type (string) - Type of the delivery method to associate this policy with. Valid values are:

    • email

    • httpjson

    • servicedesk

    • jira

    • pushover

    • pagerduty

    • slack

    • servicenow

  • name (string) - Name of the delivery method to associate this policy with.

Note

Note that both the delivery method type and name must exist in the corresponding domain. Otherwise, the request won’t work.

Example

Code Block
"deliveryMethods": [
  "type": "email",
  "name": "my-delivery-method"
]

Visit Create and manage delivery methods to know more.

isDefault

boolean

If you set this to true, this policy will be automatically assigned to new alerts and predefined alerts that have not actively been assigned a sending policy.

antiFloodingPolicy

Frequency limit established for persistent alerts. You can choose between none, default, or one of your own creation.

Visit Create and manage delivery methods to know more.

scheduled

object

Days and hours during which alerts should be distributed. The time zone defined in the delivery method(s) selected is used to calculate times.

Define an object with the following parameters:

  • days (string) - Enter the weekdays you want the alert to be distributed. Indicate the specific days between brackets

, for

  • []. For example:

Code Block
"days": [
    "MONDAY",
    "TUESDAY",
    "WEDNESDAY",
    "THURSDAY",
    "FRIDAY",
    "SATURDAY",
    "SUNDAY"
],

  • from - Indicate the starting time for alerts to be sent.

  • to -

Example

Code Block
"scheduled": {
    "days": [
        "TUESDAY",
        "THURSDAY"
    ],
    "from": "00:00",
    "to": "23:59"
},
Expand
titleResponse

Check the list of available responses:

Code

Description

200

Successful response.

Details of the sending policy retrieved

Sending policy created.

Code Block
{
  "id": 123,
  "name": "default-delivery",
  "isDefault": true,
  "scheduled": {
    "days": [
      "MONDAY",
      "TUESDAY",
      "WEDNESDAY",
      "THURSDAY",
      "FRIDAY",
      "SATURDAY",
      "SUNDAY"
    ],
    "from": "00:00",
    "to": "23:59"
  },
  "deliveryMethods": [
    {
      "id": 331,
      "type": "email",
      "name": "default-email"
    }
  ],
  "antiFloodingPolicy": {
    "id": 267,
    "name": "default AF"
  }
}

400

Request error.

Code Block
{
  "code": 400,
  "msg": "string",
  "cid": "string"
}

403

Authentication required.

Code Block
{
  "code": 403,
  "msg": "string",
  "cid": "string"
}

...

 Anchor
tag5
tag5
DELETE/policies/{id}
Deletes a sending policy.
 Expand
titleRequest
Path parameters
Add the following path parameters as part of the endpoint:
Parameter
Type
Definition
id required
integer
ID of the sending policy you want to delete.
 Note
How can I get the ID of a sending policy
You can use the GET/policies endpoint to get the IDs of the sending policies defined in your domain.
Example
Find below a request example in cURL language. This request will delete the sending policy with ID 123 in the domain that corresponds to the given token. Learn how to authorize your request in this article.
 Code Block
curl -H "standAloneToken:YOUR_TOKEN" -X DELETE "https://api-us.devo.com/delco/policies/123"
...