Deployments

List deployments

get

List deployments

Query parameters
searchstringOptional
statusstringOptional
seedTypestring · enumOptionalPossible values:
offsetintegerOptional

Pagination offset

limitinteger · min: 1 · max: 100Optional

Pagination limit

orderBystringOptional

Order the results by this field, in this direction

Example: createdAt:descPattern: ^[a-zA-Z0-9\_]+(:(asc|desc))?$
Responses
200
OK
application/json
get
GET /api/deployments HTTP/1.1
Host: app.seedata.io
Accept: */*
200

OK

{
  "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-06-23T22:41:47.145Z",
      "destinationId": "123e4567-e89b-12d3-a456-426614174000",
      "failureMessage": "text",
      "muteNotifications": true,
      "seedImpact": 1,
      "createdAt": "2025-06-23T22:41:47.145Z",
      "updatedAt": "2025-06-23T22:41:47.145Z",
      "createdByType": "text",
      "createdById": "text",
      "updatedByType": "text",
      "updatedById": "text"
    }
  ]
}

Create deployment

post

Endpoint used for creating a deployment schedule.

Body

An entity which creates, plants & retires seeds on a schedule or a one-time occurance.

idstring · uuidRead-onlyOptional
namestringRequired
descriptionstring | nullableOptional
statusstring · enumRequiredPossible values:
organisationIdstring · uuidOptional
seedTypestring · enumRequiredPossible values:
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
201
Created
application/json
post
POST /api/deployments HTTP/1.1
Host: app.seedata.io
Content-Type: application/json
Accept: */*
Content-Length: 409

{
  "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-06-23T22:41:47.145Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "muteNotifications": true,
  "seedImpact": 1
}
201

Created

{
  "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-06-23T22:41:47.145Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": true,
  "seedImpact": 1,
  "createdAt": "2025-06-23T22:41:47.145Z",
  "updatedAt": "2025-06-23T22:41:47.145Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text"
}

Get deployment

get

Get a single deployment schedule

Path parameters
deployment_schedule_idstring · uuidRequired
Responses
200
OK
application/json
get
GET /api/deployments/{deployment_schedule_id} HTTP/1.1
Host: app.seedata.io
Accept: */*
200

OK

{
  "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-06-23T22:41:47.145Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": true,
  "seedImpact": 1,
  "createdAt": "2025-06-23T22:41:47.145Z",
  "updatedAt": "2025-06-23T22:41:47.145Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text"
}

Delete deployment

delete

Delete a deployment schedule

Path parameters
deployment_schedule_idstring · uuidRequired
Responses
200
OK
application/json
delete
DELETE /api/deployments/{deployment_schedule_id} HTTP/1.1
Host: app.seedata.io
Accept: */*
200

OK

{
  "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-06-23T22:41:47.145Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": true,
  "seedImpact": 1,
  "createdAt": "2025-06-23T22:41:47.145Z",
  "updatedAt": "2025-06-23T22:41:47.145Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text"
}

Update deployment

patch
Path parameters
deployment_schedule_idstring · uuidRequired
Body
statusstringOptional

Deployment Status

muteNotificationsbooleanOptional

Mute notifications from this deployment

Responses
200
OK
application/json
patch
PATCH /api/deployments/{deployment_schedule_id} HTTP/1.1
Host: app.seedata.io
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "status": "text",
  "muteNotifications": true
}
200

OK

{
  "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-06-23T22:41:47.145Z",
  "destinationId": "123e4567-e89b-12d3-a456-426614174000",
  "failureMessage": "text",
  "muteNotifications": true,
  "seedImpact": 1,
  "createdAt": "2025-06-23T22:41:47.145Z",
  "updatedAt": "2025-06-23T22:41:47.145Z",
  "createdByType": "text",
  "createdById": "text",
  "updatedByType": "text",
  "updatedById": "text"
}
PreviousData widgetsNextEvents

Was this helpful?