Bulk

Bulk actions on seeds

Perform bulk actions on multiple seeds

POSThttps://app.seedata.io/api/seeds/bulk

Body

application/json

seedIds*array of string (uuid)

action*enum

retiretestupdate

testTypeenum

The type of test to perform (Only valid for test action)

urlemailwebResultOpenWebwebResultDeepDarkWebawsCredentialshoneypot

retiredAtstring (date-time)

When the seed should be retired. Should be a UTC date in the future. If no input is provided it will default to UTC now. This operation will fail if the seed has already been retired. (Only valid for retire action)

descriptionstring

An arbitrary user provided description for the seed. (Only valid for update action)

muteNotificationsUntilstring (date-time)

The date until which notifications for events related to this seed will be muted. The date has to be in the future, otherwise the operation will result in an error (Only valid for update action)

Response

200

OK

Body

application/json

seedsarray of Seed

Request

JavaScriptCurlPython

const response = await fetch('https://app.seedata.io/api/seeds/bulk', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "action": "retire",
      "seedIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }),
});
const data = await response.json();

Response

200

{
  "seeds": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "email",
      "contentType": "text",
      "contentKeywords": [
        "text"
      ],
      "slug": "yellow-jump-magic",
      "domain": "example.com",
      "description": "text",
      "plantedDescription": "text",
      "plantedLocation": "text",
      "plantedMethodId": "text",
      "muteNotificationsUntil": "2024-11-21T06:29:45.345Z",
      "status": "initialising",
      "locked": false,
      "eventCount": 0,
      "seedImpact": 0,
      "seedMetadata": {
        "md5SeededFileHash": "text",
        "locale": "text",
        "title": "text",
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "password": "text",
        "dob": "text",
        "company": "text",
        "phoneDialCode": "text",
        "phone": "text",
        "address": "text",
        "addressLine1": "text",
        "addressCity": "text",
        "addressCountry": "text",
        "addressZipCode": "text"
      },
      "plantedAt": "2024-11-21T06:29:45.345Z",
      "plantedByType": "text",
      "plantedById": "123e4567-e89b-12d3-a456-426614174000",
      "retiredAt": "2024-11-21T06:29:45.345Z",
      "retiredByType": "text",
      "retiredById": "123e4567-e89b-12d3-a456-426614174000",
      "createdByType": "text",
      "createdById": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2024-11-21T06:29:45.345Z",
      "downloadedByType": "text",
      "downloadedById": "123e4567-e89b-12d3-a456-426614174000",
      "downloadedAt": "2024-11-21T06:29:45.345Z",
      "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2024-11-21T06:29:45.345Z",
      "externalIdentifier": "text"
    }
  ]
}