Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Overview
Check the list of available endpoints and methods to work with sending policies using the Delivery methods API:
...
Endpoints and methods
...
Description
...
Status | ||||
---|---|---|---|---|
|
/policies
see belowTable of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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. | ||||||
/policy/{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
Anchor | ||||
---|---|---|---|---|
|
/policies
Retrieves a list of the sending policies in the domain.
...
Expand | ||
---|---|---|
| ||
Check the list of available responses: |
Gets a detailed description of a specific sending policy given its ID.
Expand | |||
---|---|---|---|
| |||
Path parametersAdd the following path parameters as part of the endpoint: | |||
Parameter | Type | Definition |
|
|
Note | |||
Code Block |
Code | Description | ||
---|---|---|---|
200 | Successful response. Available sending policies retrieved.
| ||
400 | Request error.
| ||
403 | Authentication required.
|
...
|
Anchor | ||||
---|---|---|---|---|
|
/policy/{id}
Gets a detailed description of a specific sending policy given its ID.
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
ExampleFind 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.
|
Expand | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Check the list of available responses:
|
Anchor | ||||
---|---|---|---|---|
|
/policies
Creates a new sending policy.
Expand | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||
Request bodyYou must specify the updates you need to apply to the delivery method in the request body:
|
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Check the list of available responses:
|
Anchor |
---|
...
|
...
|
...
PUT/policies
Creates a new Edits an existing sending policy.
Expand | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||
Request bodyYou must specify the updates you need to apply to the delivery method in the request body:
|
Expand | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Check the list of available responses:
|
...
Anchor | ||||
---|---|---|---|---|
|
/policies/{id}
Deletes a sending policy.
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Path parametersAdd the following path parameters as part of the endpoint:
ExampleFind below a request example in cURL language. This request will delete the sending policy with ID
|
...