Skip to main content

Overview

The Add Contact webhook allows partners to create a new contact record in PitchCRM. At least one of email or phoneNo must be provided — requests missing both will return a 400 error.

Endpoint

POST https://partner.api.v3.pitchcrm.com/v3/partner/webhook/contact/add

Request Body

{
  "email": "testuser@example.com",
  "firstName": "Test",
  "lastName": "User",
  "phoneNo": "+1234567890",
  "addrOne": "2nd Floor",
  "addrTwo": "123 Main St",
  "city": "Test City",
  "country": "US",
  "state": "CA",
  "zipCode": "12345",
  "gender": "male",
  "dateOfBirth": "1990-01-01",
  "emailOptStatus": 0,
  "smsOptStatus": 0,
  "tag": ["test_tag_123", "test_tag_456"]
}

Field Reference

FieldTypeRequiredDescription
emailStringConditionalContact email address. Required if phoneNo is not provided.
phoneNoStringConditionalContact phone number. Required if email is not provided.
firstNameStringOptionalContact first name
lastNameStringOptionalContact last name
addrOneStringOptionalAddress line 1
addrTwoStringOptionalAddress line 2
cityStringOptionalCity
countryStringOptionalCountry code (e.g. US, UK, CA, AU, NZ, IN)
stateStringOptionalState or province code
zipCodeStringOptionalZIP or postal code
genderStringOptionalmale, female, or other
dateOfBirthDateOptionalFormat: YYYY-MM-DD
emailOptStatusIntegerOptional0 = Opt-out, 1 = Opt-in
smsOptStatusIntegerOptional0 = Opt-out, 1 = Opt-in
tagArrayOptionalList of tag name strings
playerTypeArrayOptionalList of player type name strings
email and phoneNo are both listed as Optional but at least one must be included in every request.

Success Response

Status: 200 OK
{
  "status": "success",
  "contactId": "1234567890"
}

Error Responses

HTTP CodeError MessageDescription
400Either email or phoneNo is requiredBoth email and phoneNo are missing
401Invalid API credentialsx-api-key or x-api-secret is incorrect
403Unauthorized account accessx-account-id mismatch
429Rate limit exceeded. Try again later.More than 100 requests per minute
500Internal server errorUnexpected server-side issue