Deployments | seedata.io DOCS

seedata.io DOCS

Get deployment

get

Get a single deployment schedule

Path parameters

deployment_schedule_idstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.seedata.io/api/deployments/{deployment_schedule_id}'

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "status": "running",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "seedType": "email",
  "seedContentType": "text",
  "seedContentKeywords": [
    "text"
  ],
  "seedContentLocales": [
    "text"
  ],
  "maxSeeds": 1,
  "seedLifespan": 1,
  "scheduleRate": "text",
  "nextScheduledRun": "2025-03-31T16:11:30.214Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": true,
  "seedImpact": 1,
  "createdAt": "2025-03-31T16:11:30.214Z",
  "updatedAt": "2025-03-31T16:11:30.214Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text"
}

Delete deployment

delete

Delete a deployment schedule

Path parameters

deployment_schedule_idstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://app.seedata.io/api/deployments/{deployment_schedule_id}'

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "status": "running",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "seedType": "email",
  "seedContentType": "text",
  "seedContentKeywords": [
    "text"
  ],
  "seedContentLocales": [
    "text"
  ],
  "maxSeeds": 1,
  "seedLifespan": 1,
  "scheduleRate": "text",
  "nextScheduledRun": "2025-03-31T16:11:30.214Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": true,
  "seedImpact": 1,
  "createdAt": "2025-03-31T16:11:30.214Z",
  "updatedAt": "2025-03-31T16:11:30.214Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text"
}

List deployments

get

List deployments

Query parameters

searchstringoptional

statusstringoptional

seedTypestring · enumoptional

Available options:

offsetintegeroptional

Pagination offset

limitinteger · min: 1 · max: 100optional

Pagination limit

orderBystringoptional

Order the results by this field, in this direction

Example: createdAt:desc

Pattern: ^[a-zA-Z0-9\_]+(:(asc|desc))?$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.seedata.io/api/deployments'

200

{
  "metadata": {
    "totalCount": 1,
    "offset": 1,
    "limit": 1
  },
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "status": "running",
      "organisationId": "123e4567-e89b-12d3-a456-426614174000",
      "seedType": "email",
      "seedContentType": "text",
      "seedContentKeywords": [
        "text"
      ],
      "seedContentLocales": [
        "text"
      ],
      "maxSeeds": 1,
      "seedLifespan": 1,
      "scheduleRate": "text",
      "nextScheduledRun": "2025-03-31T16:11:30.214Z",
      "destinationId": "123e4567-e89b-12d3-a456-426614174000",
      "failureMessage": "text",
      "muteNotifications": true,
      "seedImpact": 1,
      "createdAt": "2025-03-31T16:11:30.214Z",
      "updatedAt": "2025-03-31T16:11:30.214Z",
      "createdByType": "text",
      "createdById": "text",
      "updatedByType": "text",
      "updatedById": "text"
    }
  ]
}

Create deployment

post

Endpoint used for creating a deployment schedule.

Body

idstring · uuidread-onlyoptional

namestringrequired

descriptionstring | nullableoptional

statusstring · enumrequired

Available options:

organisationIdstring · uuidoptional

seedTypestring · enumrequired

Available options:

seedContentTypestring | nullableoptional

Type of content generated from AI

seedContentKeywordsstring[] | nullableoptional

List of content keywords to use for generative AI

seedContentLocalesstring[] | nullableoptional

List of locales to use for Person Seed Type

maxSeedsnumberrequired

seedLifespannumberrequired

scheduleRatestring | nullableoptional

nextScheduledRunstring · date-time | nullableoptional

destinationIdstring · uuid | nullableoptional

ID of target Integration used for the planting of seeds

failureMessagestring | nullableread-onlyoptional

muteNotificationsbooleanrequired

seedImpactnumber · min: 1 · max: 5required

The impact of the seed on the target system

createdAtstring · date-timeread-onlyoptional

updatedAtstring · date-timeread-onlyoptional

createdByTypestringread-onlyoptional

createdByIdstringread-onlyoptional

updatedByTypestring | nullableread-onlyoptional

updatedByIdstring | nullableread-onlyoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://app.seedata.io/api/deployments' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "status": "running",
    "organisationId": "123e4567-e89b-12d3-a456-426614174000",
    "seedType": "email",
    "seedContentType": "text",
    "seedContentKeywords": [
      "text"
    ],
    "seedContentLocales": [
      "text"
    ],
    "maxSeeds": 1,
    "seedLifespan": 1,
    "scheduleRate": "text",
    "nextScheduledRun": "2025-03-31T16:11:30.214Z",
    "destinationId": "123e4567-e89b-12d3-a456-426614174000",
    "muteNotifications": true,
    "seedImpact": 1
  }'

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "status": "running",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "seedType": "email",
  "seedContentType": "text",
  "seedContentKeywords": [
    "text"
  ],
  "seedContentLocales": [
    "text"
  ],
  "maxSeeds": 1,
  "seedLifespan": 1,
  "scheduleRate": "text",
  "nextScheduledRun": "2025-03-31T16:11:30.214Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": true,
  "seedImpact": 1,
  "createdAt": "2025-03-31T16:11:30.214Z",
  "updatedAt": "2025-03-31T16:11:30.214Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text"
}

Created

Update deployment

patch

Path parameters

deployment_schedule_idstring · uuidrequired

Body

statusstringoptional

Deployment Status

muteNotificationsbooleanoptional

Mute notifications from this deployment

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://app.seedata.io/api/deployments/{deployment_schedule_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "text",
    "muteNotifications": true
  }'

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "status": "running",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "seedType": "email",
  "seedContentType": "text",
  "seedContentKeywords": [
    "text"
  ],
  "seedContentLocales": [
    "text"
  ],
  "maxSeeds": 1,
  "seedLifespan": 1,
  "scheduleRate": "text",
  "nextScheduledRun": "2025-03-31T16:11:30.214Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": true,
  "seedImpact": 1,
  "createdAt": "2025-03-31T16:11:30.214Z",
  "updatedAt": "2025-03-31T16:11:30.214Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text"
}