Skip to main content

Assessor.io API v2 (public) - Participants

Read and upsert campaign participants from an external CRM. Responses are the whitelisted PublicParticipant projection: the linked Assessor.io userId, the avatar URL, and the assigned-auditor records are internal and never returned. Reads need participants:read; the upsert needs participants:write and is written to the account audit log. 1.1.0 MADE TWO metadata KEYS THE SYSTEM'S. takerLink and synthetic can no longer be written, overwritten or removed through the upsert, on create or on update; a body naming one is answered 200/201 with the stored value intact and the refused keys in meta.preservedKeys. The rest of the bag is unchanged. 1.2.0 GAVE THE UPSERT A DELETE CHANNEL. A metadata key sent as an explicit JSON null is now REMOVED from the participant's bag rather than stored as a null, which is what the same body has always meant on the v1 PATCH. The two system-owned keys are the exception and are still refused, never removed. The Public API (v2) guide on docs.assessor.io describes both changes.

Getting a token, the scopes and the response envelope are explained in Make your first API call and Public API (v2).

Contract Summary​

  • Version: 1.4.1
  • Visibility: public
  • Operations: 2
  • Tags: PublicParticipants

Operations​

MethodPathSummaryOperation ID
GET/api/v2/public/accounts/{accountId}/campaigns/{campaignId}/participantsList a campaign's participants.v2ListParticipants
POST/api/v2/public/accounts/{accountId}/campaigns/{campaignId}/participantsCreate or update one participant, keyed on email.v2UpsertParticipant

Raw Contract​