Skip to main content
POST
Create a contact and enroll it 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
phoneNumber
string
required

The contact's phone number.

teamId
string
required

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

campaignId
string

Optional. The campaign to enroll the contact in. Omit to create/update the contact only, without enrolling.

name
string
email
string
companyName
string
companyWebsite
string
timezone
string
{key}
any

Any other property is accepted and stored as a custom field on the contact.

Response

Contact created/updated (and enrolled, if campaignId was given).

message
string
Example:

"success"

contactId
string