Upload suppression list data to file

Description

Uploads a csv file containing md5 data from a suppression list.

Includes 3 requests.

1 - creating profiles export task

Request URL

Method: POST

https://example.com/api/v1.1/suppresses/export

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
id	int	1	Yes	Suppression list ID
type	string	"emails" "phones" "domains" "all"	No	Type of contact data to export. By default — all.

Request example

JSON

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "id": 1,
  "type": "emails"
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <id>1</id>
  <type>emails</type>
</xml>

Response example

JSON

{
  "data": {
    "task_id": "c110f0-06d0-4695-9aee-a9bab742d"
  },
  "error": 0,
  "error_text": "Successful operation"
}

XML

<result>
  <data>
    <task_id>c110f0-06d0-4695-9aee-a9bab742d</task_id>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</result>

Response parameters

Parameter	Type	Description
task_id	string	Export task ID
error	int	Error code
error_text	string	Error text

2 - checking export status and getting link

Request URL

Method: POST

https://example.com/api/v1.1/tasks/status

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
task_id	string	"c110f0-06d0-4695-9aee-a9bab742d"	Yes	Export task ID

Request example

JSON

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "task_id": "c110f0-06d0-4695-9aee-a9bab742d"
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <task_id>c110f0-06d0-4695-9aee-a9bab742d</task_id>
</xml>

Response example

JSON

{
  "data": {
    "status": "completed",
    "progress": 100,
    "result": {
      "hashed_file": "suppress/b5bb73d7-530d-4a64-89d4-8ad22bad73/suppress_list_name.md5.zip",
      "is_api": true,
      "regular_file": "",
      "suppress_id": 1,
      "total": 32
    }
  },
  "error": 0,
  "error_text": "Successful operation"
}

XML

<result>
  <data>
    <status>completed</status>
    <progress>100</progress>
    <result>
      <hashed_file>suppress/b5bb73d7-530d-4a64-89d4-8ad22bad73/suppress_list_name.md5.zip</hashed_file>
      <is_api>true</is_api>
      <regular_file>
      </regular_file>
      <suppress_id>1</suppress_id>
      <total>32</total>
    </result>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</result>

Response parameters

Parameter	Type	Description
status	string	Task status
progress	int	Task progress
hashed_file	array	Link to download the file with data in md5 format
is_api	bool	Export via API
suppress_id	int	Suppression list ID
total	int	Number of lines (email addresses and domains, phones) in the suppression list
error	int	Error code
error_text	string	Error text

3 - downloading result file

Request URL

Method: GET

https://example.com/api/download/suppress/b5bb73d7-530d-4a64-89d4-8ad22bad73/suppress_list_name.md5.zip?token=29b32e2a529b499a97f7ef96f98b3406

The download link is retrieved from the second response.

It is necessary to pass an API token in request parameters.