Zoho: Deal contact roles schemas

← Deal contact roles operations · All schemas

Deal Contact Roles — deal Contact Roles delete Contact Role Relation — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned after deleting contact role relations. Additional keys: not allowed
data	array	Required within parent	Status entries for each deleted relation Maximum items: 100 Minimum items: 1
data[]	object	Each item	Result for a single relation delete operation Additional keys: not allowed
data[].code	string	Required within parent	Operation status code Must equal: SUCCESS
data[].details	object	Required within parent	Details about the deleted relation Additional keys: not allowed
data[].details.id	string	Required within parent	Identifier of the deleted relation Format: int64
data[].message	string	Required within parent	Result message Must equal: relation removed
data[].status	string	Required within parent	Operation status Must equal: success

Deal Contact Roles — deal Contact Roles get Deal Contact Role For Contact — response body — data data item

Field	Type	Presence	Description and constraints
$	object	Root	Contact role record with dynamic fields based on the 'fields' query parameter Additional keys: allowed
Contact_Role	object	Optional	Contact role information Additional keys: not allowed
Contact_Role.id	string	Required within parent	Role's unique identifier Format: int64
Contact_Role.name	string	Required within parent	Role name (e.g., Developer/Evaluator) Maximum length: 255
Department	JSON	Optional
Department (anyOf 1)	string	Alternative	Department of the contact
Department (anyOf 2)	null	Alternative	Department of the contact
Owner	object	Optional	Owner information for the contact role Additional keys: not allowed
Owner.email	string	Optional	Owner's email address Format: email
Owner.id	string	Optional	Owner's unique identifier Format: int64
Owner.name	string	Optional	Owner's display name Maximum length: 255

Deal Contact Roles — deal Contact Roles upsert Contact Role Relations — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body for adding or updating contact role relations on a deal. Additional keys: not allowed
data	array	Required within parent	List of contact role relations to upsert Maximum items: 100 Minimum items: 1
data[]	object	Each item	Contact role relation definition Additional keys: not allowed
data[].Contact_Role	object	Required within parent	Contact role to associate with the relation Additional keys: not allowed
data[].Contact_Role.id	string	Required within parent	Contact role identifier Format: int64
data[].Contact_Role.name	string	Optional	Contact role display name Maximum length: 255
data[].id	string	Required within parent	Identifier of the contact relation for the deal Format: int64

Deal Contact Roles — deal Contact Roles upsert Contact Role Relations — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body of a successfully added after adding or updating contact role relations. Additional keys: not allowed
data	array	Required within parent	Status entries for each processed relation Maximum items: 100 Minimum items: 1
data[]	object	Each item	Result for processing a single relation Additional keys: not allowed
data[].code	string	Required within parent	Operation status code Must equal: SUCCESS
data[].details	object	Required within parent	Details about the processed relation Additional keys: not allowed
data[].details.id	string	Required within parent	Identifier of the processed relation Format: int64
data[].message	string	Required within parent	Result message describing the action performed Known values: relation updated, relation added
data[].status	string	Required within parent	Operation status Must equal: success