Alta API Documentation

A prospect links a person to a campaign. A single person can be a prospect in multiple campaigns.

Fields

string (uuid)

required

Unique identifier for the prospect.

string

required

Always prospect.

string (uuid)

required

The ID of the person associated with this prospect.

string (uuid)

required

The ID of the campaign this prospect belongs to.

string (date-time)

required

Timestamp when the prospect was created.

string (date-time)

required

Timestamp when the prospect was last updated.

Example

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "objectType": "prospect",
  "personId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "campaignId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "createdAt": "2024-01-12T14:00:00Z",
  "updatedAt": "2024-01-12T14:00:00Z"
}

Used in

List prospects - returns an array of prospect objects
Get a prospect - returns a single prospect object

Getting started

Endpoints

Objects & Definitions

Prospect

Fields

Example

Used in

​Fields

​Example

​Used in

Fields

Example

Used in