API: OpenSRS Email

The API: OpenSRS Hosted Email Developer Hub

Welcome to the API: OpenSRS Hosted Email developer hub. You'll find comprehensive guides and documentation to help you start working with API: OpenSRS Hosted Email as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

migration_jobs

The migration_jobs method retrieves a list of current and historical migration
jobs submitted by the requester.

Syntax

{
    <credentials object>
}

Response fields for migration_jobs

The following fields may be returned when the migration_jobs method is
submitted:

Field nameObligationDescription/Value
errorReturned if success = falseA text string that explains the error.
error_numberReturned if success = falseA number that represents the error.
jobsReturned if success = trueInformation about the jobs for the specified user.

Allowed values are:

date — The date that the job was submitted, in UNIX Epoch time.

job — The ID of the job.
successAlways returnedIndicates whether the requested change was successful or not. Allowed values are true and false.

Examples for migration_jobs

Request

{
  "credentials": {
    "user": "[email protected]",
    "password": "sw0rdf1sh"
  }
}

Response

{
  "success": true,
  "jobs": [
    {
      "date": 1326229443,
      "job": "1326229437638"
    }, 
  ]
}

Updated less than a minute ago

migration_jobs


The migration_jobs method retrieves a list of current and historical migration
jobs submitted by the requester.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.