AJO Developer - Suppression API (1.0.1)

Download OpenAPI specification:Download

With this API, you can control your outgoing messages using suppression and allow lists.

The suppression list helps you with honoring the ISPs’ feedback to preserve sending IP reputation while allow list helps you ensure that you send only to those email addresses which are in the allowed list , typically to ensure that you don't send mails to customers from your development sandbox.

Suppression

Query suppressed or allowed emails addresses

SecurityBearerAuth
Request
query Parameters
type
string

For suppressed entities use 'client', for allowed entities use 'allowed'. Default is 'client'

Enum: "client" "allowed"
orderby
string
Default: "-creationdate"

Sort parameter and direction for sorting the response. Add the prefix as -/+ for desc/asc. If unspecified, the response will be sorted in desc order. Ex. orderby=+creationdate.

limit
integer
Default: 20

Limit response to a specified positive number of objects. Ex. limit=10

start
string

Used for pagination. Specifies the criteria for next page with respect to the property specified in orderby. Ex. start=1631739725150.

property
Array of strings

Optional property filters. Please refer to api guidelines for filtering support in APIs. Filtering is supported on the following properties: creationdate, channel Ex. property=creationdate<1631739725150

header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Responses
200

A list of suppressed or allowed entities

get/config/suppression/addresses
Response samples
application/json
{
  • "_page": {
    },
  • "items": [
    ],
  • "_links": {
    }
}

Add a suppressed or allowed email address

SecurityBearerAuth
Request
query Parameters
type
string

For suppressed entities use 'client', for allowed entities use 'allowed'. Default is 'client'

Enum: "client" "allowed"
header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Request Body schema: application/json
required

The JSON for the entity

Array
required
object
comment
string
user
string
Responses
201

The newly added entity

post/config/suppression/addresses
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
[
  • {
    }
]

Query a specific suppressed or allowed email address

SecurityBearerAuth
Request
path Parameters
email
required
string

email address sought

query Parameters
type
string

For suppressed entities use 'client', for allowed entities use 'allowed'. Default is 'client'

Enum: "client" "allowed"
header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Responses
200

Returning a specific suppression or allowed entity

get/config/suppression/addresses/{email}
Response samples
application/json
{
  • "id": "91acd0b4-753b-4366-8893-d5440c4d9b15",
  • "entity": {
    },
  • "suppressed": {
    },
  • "creationDate": "1631739725150",
  • "lastModifiedDate": "1631739725150",
  • "status": "active",
  • "listType": "client",
  • "client": {
    },
  • "bounceState": {
    }
}

Delete a specific suppressed or allowed email address

SecurityBearerAuth
Request
path Parameters
email
required
string

email address sought

query Parameters
type
string

For suppressed entities use 'client', for allowed entities use 'allowed'. Default is 'client'

Enum: "client" "allowed"
header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Responses
204

Entity deleted

delete/config/suppression/addresses/{email}

Query suppressed or allowed domains

SecurityBearerAuth
Request
query Parameters
type
string

For suppressed entities use 'client', for allowed entities use 'allowed'. Default is 'client'

Enum: "client" "allowed"
orderby
string
Default: "-creationdate"

Sort parameter and direction for sorting the response. Add the prefix as -/+ for desc/asc. If unspecified, the response will be sorted in desc order. Ex. orderby=+creationdate.

limit
integer
Default: 20

Limit response to a specified positive number of objects. Ex. limit=10

start
string

Used for pagination. Specifies the criteria for next page with respect to the property specified in orderby. Ex. start=1631739725150.

property
Array of strings

Optional property filters. Please refer to api guidelines for filtering support in APIs. Filtering is supported on the following properties: creationdate, channel Ex. property=creationdate<1631739725150

header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Responses
200

A list of suppressed or allowed entities

get/config/suppression/domains
Response samples
application/json
{
  • "_page": {
    },
  • "items": [
    ],
  • "_links": {
    }
}

Add a suppressed or allowed domain

SecurityBearerAuth
Request
query Parameters
type
string

For suppressed entities use 'client', for allowed entities use 'allowed'. Default is 'client'

Enum: "client" "allowed"
header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Request Body schema: application/json
required

The JSON for the entity

Array
required
object
comment
string
user
string
Responses
201

The newly added entity

post/config/suppression/domains
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
[
  • {
    }
]

Query a specific suppressed or allowed domain

SecurityBearerAuth
Request
path Parameters
domain
required
string

domain sought

header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Responses
200

A list of suppressed or allowed entities

get/config/suppression/domains/{domain}
Response samples
application/json
{
  • "id": "91acd0b4-753b-4366-8893-d5440c4d9b15",
  • "entity": {
    },
  • "suppressed": {
    },
  • "creationDate": "1631739725150",
  • "lastModifiedDate": "1631739725150",
  • "status": "active",
  • "listType": "client",
  • "client": {
    }
}

Delete a specific suppressed or allowed domain

SecurityBearerAuth
Request
path Parameters
domain
required
string

domain sought

header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Responses
204

Entity deleted

delete/config/suppression/domains/{domain}
Response samples
application/json
{
  • "id": "91acd0b4-753b-4366-8893-d5440c4d9b15",
  • "entity": {
    },
  • "suppressed": {
    },
  • "creationDate": "1631739725150",
  • "lastModifiedDate": "1631739725150",
  • "status": "active",
  • "listType": "client",
  • "client": {
    }
}

Upload a CSV file of suppressed entities

SecurityBearerAuth
Request
header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Content-Type
required
string

The content type of the request body. Should be 'multipart/form-data'.

Example: multipart/form-data
Request Body schema: multipart/form-data
required
file
string

The full path of the file that is to be uploaded.

Responses
201

The CSV file has been accepted. This is an asynchronous call and will finish sometime in the future.

post/config/suppression/uploads
Response samples
application/json
{
  • "success": {
    }
}

Fetch upload jobs

SecurityBearerAuth
Request
query Parameters
orderby
string
Default: "-creationdate"

Sort parameter and direction for sorting the response. Add the prefix as -/+ for desc/asc. If unspecified, the response will be sorted in desc order. Ex. orderby=+creationdate.

limit
integer
Default: 20

Limit response to a specified positive number of objects. Ex. limit=10

start
string

Used for pagination. Specifies the criteria for next page with respect to the property specified in orderby. Ex. start=1631739725150.

property
Array of strings

Optional property filters. Please refer to api guidelines for filtering support in APIs. Filtering is supported on the following properties: creationdate, channel Ex. property=creationdate<1631739725150

header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Responses
200

A list of suppressed or allowed entities

get/config/suppression/uploads
Response samples
application/json
{
  • "_page": {
    },
  • "items": [
    ],
  • "_links": {
    }
}

Query a specific upload job

SecurityBearerAuth
Request
path Parameters
jobId
required
string

Upload job to fetch

header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Responses
200

Returns a specific upload job

get/config/suppression/uploads/{jobId}
Response samples
application/json
{
  • "imsOrgId": "225F37C35E4B776E0A49421B@AdobeOrg",
  • "sandboxId": "70f22060-5d47-11ea-bdff-a5384333ff34",
  • "failedRecords": [
    ],
  • "jobId": "6caaed1b-d7bd-4065-a745-185e9af3b63a",
  • "user": "username@mydomain.com",
  • "filename": "mysuppressions.csv",
  • "createTime": 1643768895,
  • "endTime": 1643768895,
  • "status": "ACCEPTED",
  • "responseCode": 200,
  • "responseText": "The file is malformed, only CSV files are allowed.",
  • "recordCount": 14502,
  • "handledCount": 12342,
  • "failedCount": 17
}

Delete a specific upload job.

The purpose of this operation is to delete the job record created. It does not delete the suppressions created through the job.

SecurityBearerAuth
Request
path Parameters
jobId
required
string

Upload job to fetch

header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Responses
204

Job deleted

delete/config/suppression/uploads/{jobId}

Delete all suppressions from a given sandbox-Id and IMS-Org-Id

SecurityBearerAuth
Request
path Parameters
imsOrgId
required
string

IMS Organization Id

sandboxId
required
string

Sandbox Id

header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Responses
202

The request has been accepted and will be completed asynchronously

delete/config/suppression/admin/{imsOrgId}/{sandboxId}