Skip to main content
POST
Enroll a contact in a campaign

Authorizations

Authorization
string
header
required

Pass your team's API key as a Bearer token: Authorization: Bearer YOUR_API_KEY. Find your API key in the dashboard under Settings. The key must belong to the same team as the teamId in the request body.

Body

application/json
contactId
string
required

The Revve contact ID to enroll.

teamId
string
required

Your Revve team ID. Must match the team the API key belongs to.

campaignId
string
required

The campaign to enroll the contact in. Must be an active campaign.

source
string

Optional free-text label recorded against the enrollment, for your own tracking of where it came from.

version
string

Which campaign version to enroll against: current, draft, or a specific campaign_versions.id. Defaults to current if omitted.

Response

Contact enrolled successfully.

message
string
Example:

"Contact enrolled successfully"

enrollmentId
string