Contacts methods
POST
recipient/create
This method creates new recipient email.
Request url
https://api.sendigo.com/recipient/create
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx

data: {"emails":"[email protected]"}
or
data: {"emails":["[email protected]","[email protected]"]}
Criteria Description
email Array that contains only email strings
POST
recipient/update
This method update existing recipient email.
Request url
https://api.sendigo.com/recipient/update
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx

data: {"emails":[["[email protected]","null",5]]}
or
data: {"emails":["[email protected]","[email protected]"]}
Criteria Description
email Array that contains arrays where one array contains as first param email that will be updated, second param email that will be replaced (corrected), if null, email wont be affected, third param will be status, if null will be changed to 1 by default
POST
recipient/delete
This method delete existing recipient email.
Request url
https://api.sendigo.com/recipient/delete
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx

data: {"emails":"[email protected]"}
or
data: {"emails":["[email protected]","[email protected]"]}
Criteria Description
email Array that contains email list that will be deleted
POST
recipient/info
This method returns existing recipient info (email, status, create-date, update-date).
Request url
https://api.sendigo.com/recipient/info
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx

data: {"email":"[email protected]"}
Criteria Description
email Recipient email string
POST
recipient/list
This method returns list of all existing recipient emails.
Request url
https://api.sendigo.com/recipient/list
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx
POST
recipient/search
This method list recipients by email.
Request url
https://api.sendigo.com/recipient/search
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx

data: {"email":"[email protected]"}
Criteria Description
email Recipient email string
POST
recipient/searchbystatus
This method list recipients by status (1 for active; 2 for unsubscribe; 3 for bounced; 4 for malformed; 5 for hidden).
Request url
https://api.sendigo.com/recipient/searchbystatus
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx

data: {"status":"1"}
Criteria Description
status Status (1 for active; 2 for unsubscribe; 3 for bounced; 4 for malformed; 5 for hidden)
POST
recipient/createwithmetadata
This method can be used to upload recipients, update them by adding status (1 for active; 2 for unsubscribe; 3 for bounced; 4 for malformed; 5 for hidden), also can be used to add recipient meta tags.
Request url
https://api.sendigo.com/recipient/createwithmetadata
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx

data: {
"updateMetaData": "true/false",
"updateRecipient": true/false,
"recipientStatus": 1,
"recipients": [{
"email": "[email protected]",
"metadata": [{
"key": "example_key",
"value": "example_value",
"description": "example description"
}]
}}
]]
}
Criteria Description
updateMetaData Optional true / false, if true, metadata values with same metadata key will be deleted except the new one, if false, a new metadata value will be added with specified key.
updateRecipient Optional true / false, if true, recipient status will be updated to active, or the one that is provided, if false, wont affect recipient status and will only update metadata.
recipientStatus Optional (1 for active; 2 for unsubscribe; 3 for bounced; 4 for malformed; 5 for hidden) will change recipient status to spiecified, by default will be set to active.
recipients Required Requires an array with json data thats contains recipient email and metadata (optional). Metada should contain an array with json data with key, value and description in it.
POST
recipient/listmetadatakeys
This method can be used to list all metadata keys with or without values.
Request url
https://api.sendigo.com/recipient/listmetadatakeys
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx

data: {
"values": "true/false"
}
Criteria Description
values Optional true / false, if true, will show values of metadata keys
POST
recipient/deletemetadatakey
This method can be used to delete a metadata key and all of its values.
Request url
https://api.sendigo.com/recipient/deletemetadatakey
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx

data: {
"key": "example key"
}
Criteria Description
key Required Metadata key that should be deleted.
POST
recipient/deletemetadatavalue
This method can be used to delete metadata values.
Request url
https://api.sendigo.com/recipient/deletemetadatavalue
Request body
appId: xxxxxxxxxxxxxxxxxxxxxxxxxx

data: {
"key": "example key",
"value": "example value"
}
Criteria Description
key Required Metadata key that os value.
value Required Metadata value that should be deleted.