Birdeye · Schema

Create Or Update Contact Request

Reputation ManagementReviewsCustomer ExperienceSurveysMessagingMulti-LocationAI

Properties

Name Type Description
id string
firstName string
lastName string
email string
phone string
countryCode string
smsOptin boolean
emailOptin boolean
blocked boolean
businessIds array
tags string
customFields array
externalId string
View JSON Schema on GitHub

JSON Schema

create-or-update-contact-request.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/json-schema/create-or-update-contact-request.json",
  "title": "Create Or Update Contact Request",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "phone": {
      "type": "string"
    },
    "countryCode": {
      "type": "string"
    },
    "smsOptin": {
      "type": "boolean"
    },
    "emailOptin": {
      "type": "boolean"
    },
    "blocked": {
      "type": "boolean"
    },
    "businessIds": {
      "type": "array"
    },
    "tags": {
      "type": "string"
    },
    "customFields": {
      "type": "array"
    },
    "externalId": {
      "type": "string"
    }
  }
}