Retire

Retire Seed

post

Set the seed status to retired

Path parameters

seedIdstring · uuidRequired

Body

application/json

retiredAtstring · date-timeOptional

When the seed should be retired. Should be a UTC date in the future. If not input is provided it will default to UTC now. This operation will fail if the seed has already been retired.

Responses

200

OK

application/json

post

/seeds/{seedId}/retire

HTTPcURLJavaScriptPython

POST /api/seeds/{seedId}/retire HTTP/1.1
Host: app.seedata.io
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "retiredAt": "2026-01-31T02:38:20.270Z"
}

200

OK

{
  "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": "2026-01-31T02:38:20.270Z",
  "status": "initialising",
  "locked": true,
  "eventCount": 1,
  "seedImpact": 1,
  "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": "2026-01-31T02:38:20.270Z",
  "plantedByType": "text",
  "plantedById": "123e4567-e89b-12d3-a456-426614174000",
  "retiredAt": "2026-01-31T02:38:20.270Z",
  "retiredByType": "text",
  "retiredById": "123e4567-e89b-12d3-a456-426614174000",
  "createdByType": "text",
  "createdById": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-01-31T02:38:20.270Z",
  "downloadedByType": "text",
  "downloadedById": "123e4567-e89b-12d3-a456-426614174000",
  "downloadedAt": "2026-01-31T02:38:20.270Z",
  "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-01-31T02:38:20.270Z",
  "externalIdentifier": "text"
}