The base definition for a contact.
| Property | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| address required nullable |
The address for this contact. |
||||||||
| birthDate nullable |
The date on which this contact was born. |
||||||||
| birthDateDisplay read-only |
The date on which this contact was born, properly formatted according to the brand’s locale. |
||||||||
| brandId write-only deprecated |
When creating a contact, a This is deprecated in favor of using the other brand's contact collection resource to create contacts for the brand. |
||||||||
| businessName nullable |
The name for the business with which this contact is associated. |
||||||||
| created read-only |
The date on which this contact was created |
||||||||
|
The email address for this contact. |
|||||||||
| firstName nullable |
The first name for this contact. |
||||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||
| lastName nullable |
The last name for this contact. |
||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||
| name nullable |
The full name for this contact. |
||||||||
| notes nullable |
Notes made by the studio about this contact. |
||||||||
| phone nullable |
The phone number for this contact. |
||||||||
| refereeContacts read-only |
Contacts that have been referred by this contact. |
||||||||
| referringContact nullable read-only |
The contact who referred this contact. |
||||||||
| referringContactId nullable |
The identifier for the contact who referred this contact. |
||||||||
| resourceCounts read-only |
|
||||||||
| tags |
Tags describing this contact. |
||||||||
| thirdPartyId nullable |
The identifier for this contact in the source system from which it originated. |
||||||||
| type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "The base definition for a contact.",
"properties": {
"address": {
"allOf": [
{
"description": "The address for this contact.",
"nullable": true
},
{
"$ref": "#/components/schemas/Address"
}
]
},
"birthDate": {
"description": "The date on which this contact was born.",
"format": "date",
"nullable": true,
"type": "string"
},
"birthDateDisplay": {
"description": "The date on which this contact was born, properly formatted according to the brand’s locale.",
"format": "date",
"readOnly": true,
"type": "string"
},
"brandId": {
"allOf": [
{
"deprecated": true,
"description": "When creating a contact, a `brandId` may be provided to create\nthe contact under a different brand.\n\n*This is deprecated in favor of using the other brand's contact\ncollection resource to create contacts for the brand.*",
"writeOnly": true
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"businessName": {
"description": "The name for the business with which this contact is associated.",
"nullable": true,
"type": "string"
},
"created": {
"description": "The date on which this contact was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"email": {
"description": "The email address for this contact.",
"format": "email",
"type": "string"
},
"firstName": {
"description": "The first name for this contact.",
"nullable": true,
"type": "string"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"lastName": {
"description": "The last name for this contact.",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"name": {
"description": "The full name for this contact.",
"nullable": true,
"type": "string"
},
"notes": {
"description": "Notes made by the studio about this contact.",
"nullable": true,
"type": "string"
},
"phone": {
"description": "The phone number for this contact.",
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"refereeContacts": {
"description": "Contacts that have been referred by this contact.",
"items": {
"$ref": "#/components/schemas/ContactMinimal"
},
"readOnly": true,
"title": "Contact",
"type": "array"
},
"referringContact": {
"allOf": [
{
"description": "The contact who referred this contact.",
"nullable": true,
"readOnly": true
},
{
"$ref": "#/components/schemas/ContactMinimal"
}
]
},
"referringContactId": {
"allOf": [
{
"description": "The identifier for the contact who referred this contact.",
"nullable": true
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"resourceCounts": {
"properties": {
"numContracts": {
"description": "The number of contracts with which this contact is associated.",
"type": "integer"
},
"numEvents": {
"description": "The number of events with which this contact is associated.",
"type": "integer"
},
"numInvoices": {
"description": "The number of invoices with which this contact is associated.",
"type": "integer"
}
},
"readOnly": true,
"type": "object"
},
"tags": {
"description": "Tags describing this contact.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"thirdPartyId": {
"description": "The identifier for this contact in the source system from which it\noriginated.",
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"type": {
"allOf": [
{
"enum": [
"contact"
]
},
{
"$ref": "#/components/schemas/Type"
}
]
}
},
"required": [
"type",
"email",
"name"
],
"title": "Base Contact",
"type": "object"
}