View Source

Overview

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

Endpoints and methods	Description
`/policies` ^{see below}	Lists the available sending policies in the domain.
`/policies/{id}` ^{see below}	Gets a detailed description of a specific sending policy.
`/policies` ^{see below}	Creates a new sending policy.
`/policies` ^{see below}	Edits a sending policy.
`/policies/{id}` ^{see below}	Deletes a sending policy.

Endpoints and methods

GET `/policies`

Retrieves a list of the sending policies in the domain.

To perform this request, your Devo user must have at least the Alert configuration (view) permission assigned. Learn more about roles and permissions in this article.

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.

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

Check the list of available responses:

Code

Description

200

Successful response. Available sending policies retrieved.

[
  {
    "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": 400,
  "msg": "string",
  "cid": "string"
}

403

Authentication required.

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

GET `/policies/{id}`

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

To perform this request, your Devo user must have at least the Alert configuration (view) permission assigned. Learn more about roles and permissions in this article.

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.

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.

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

Check the list of available responses:

Code

Description

200

Successful response. Details of the sending policy retrieved.

{
  "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": 400,
  "msg": "string",
  "cid": "string"
}

403

Authentication required.

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

POST `/policies`

Creates a new sending policy.

To perform this request, your Devo user must have the Alert configuration (manage) permission assigned. Learn more about roles and permissions in this article.

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:

id (integer) - The ID of the desired delivery method. You can use the /methods endpoint to check the ID (more details here).

Example

"deliveryMethods": [
    4668
  ]

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:

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

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

Example

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

Request example

curl --location --request POST 'https://api-us.devo.com/delco/policies' --header "standAloneToken:$token" --header 'Content-Type: application/json' --data '
{
  "name": "support36555example",
  "isDefault": false,
  "scheduled": {
    "days": [
      "MONDAY",
      "TUESDAY",
      "WEDNESDAY",
      "THURSDAY",
      "FRIDAY"
    ],
    "from": "00:00",
    "to": "23:59"
  },
  "deliveryMethods": [
    4668
  ]
}
'

Check the list of available responses:

Code

Description

200

Successful response. Sending policy created.

{
  "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": 400,
  "msg": "string",
  "cid": "string"
}

403

Authentication required.

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

PUT`/policies`

Edits an existing sending policy.

To perform this request, your Devo user must have the Alert configuration (manage) permission assigned. Learn more about roles and permissions in this article.

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:

id (integer) - The ID of the desired delivery method. You can use the /methods endpoint to check the ID (more details here).

Example

"deliveryMethods": [
    4668
  ]

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:

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

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

Example

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

Request example

curl --location --request PUT 'https://api-us.devo.com/delco/policies' --header "standAloneToken:$token" --header 'Content-Type: application/json' --data '
{
  "name": "support36555example",
  "isDefault": false,
  "scheduled": {
    "days": [
      "MONDAY",
      "TUESDAY",
      "WEDNESDAY",
      "THURSDAY",
      "FRIDAY"
    ],
    "from": "00:00",
    "to": "23:59"
  },
  "deliveryMethods": [
    4668
  ]
}
'

Check the list of available responses:

Code

Description

200

Successful response. Sending policy created.

{
  "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": 400,
  "msg": "string",
  "cid": "string"
}

403

Authentication required.

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

DELETE `/policies/{id}`

Deletes a sending policy.

To perform this request, your Devo user must have the Alert configuration (manage) permission assigned. Learn more about roles and permissions in this article.

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.

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.

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

Check the list of available responses:

Code

Description

204

No content. Successful response. Sending policy deleted.

400

Request error.

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

403

Authentication required.

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

Overview

Endpoints and methods

GET /policies

Example

GET /policies/{id}

Path parameters

Example

POST /policies

Request body

Request example

PUT/policies

Request body

Request example

DELETE /policies/{id}

Path parameters

Example

GET `/policies`

GET `/policies/{id}`

POST `/policies`

PUT`/policies`

DELETE `/policies/{id}`