SEsendspark
Dynamics Campaign

Get prospect data from prospect email

Changed on

Get prospect data from prospect email

get/v1/workspaces/{workspaceId}/dynamics/{dynamicId}/prospects/{contactEmail}

Request

  • Base URL
    https://api-gw.sendspark.com
  • Auth
    API key in header x-api-key and API key in header x-api-secret

Path parameters

workspaceIdstring required
dynamicIdstring required
contactEmailstring required

Query parameters

includestring

Comma-separated list of additional fields to include in the response (emailEmbedHTML, fields)

Response

Successful

contactEmailstring
backgroundUrlstring
originalBackgroundUrlstring
statusstring
deletedAtstring date
validboolean
createdAtstring date
updatedAtstring date
contactNamestring
companystring
jobTitlestring
idstring
shareUrlstring
emailEmbedHTMLstring

HTML code for email embedding

fieldsModel101

Additional fields associated with the prospect

Example response

{
  "contactEmail": "Contact Email, Example: john@example.com",
  "backgroundUrl": "Backgound URL, Example: https://example.com",
  "originalBackgroundUrl": "Backgound URL, Example: https://example.com",
  "status": "Current prospect status, Example: saved, billed, errored, processing, uploaded, completed",
  "deletedAt": "Deleted Date if prospect was deleted, Example: 2020-01-01T00:00:00.000Z",
  "createdAt": "Create date, example: 2020-01-01T00:00:00.000Z",
  "updatedAt": "Update date, example: 2020-01-01T00:00:00.000Z",
  "validationDetails": [
    {
      "validationField": "Show field with errors, Example: contactEmail",
      "validationMessage": "Show error detail related with field with error, example: Invalid email",
      "validationCode": "Show error code related with field with error, example: 400"
    }
  ],
  "contactName": "Contact Name, example: John Doe",
  "company": "Company Name, example: Sendspark",
  "jobTitle": "Job Title, example: Software Engineer",
  "id": "Internal prospect ID, example: 997f191e810c19729de860fd",
  "shareUrl": "Public URL to share the final video, example: https://sendspark.com/share/997f191e81"
}

Changes