LegacyTeamsAddNewTeamResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"allOf": [
{
"type": "object",
"title": "teamId",
"properties": {
"id": {
"type": "integer",
"description": "The team ID"
}
}
},
{
"type": "object",
"allOf": [
{
"allOf": [
{
"type": "object",
"title": "addTeamRequest",
"properties": {
"name": {
"type": "string",
"description": "The team name"
},
"users": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The list of user IDs"
},
"manager_id": {
"type": "integer",
"description": "The team manager ID"
},
"description": {
"type": "string",
"description": "The team description"
}
}
},
{
"type": "object",
"properties": {
"active_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Flag that indicates whether the team is active"
},
"deleted_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Flag that indicates whether the team is deleted"
}
}
}
],
"title": "updateTeamRequest"
},
{
"type": "object",
"title": "baseTeamAdditionalProperties",
"properties": {
"add_time": {
"type": "string",
"description": "The team creation time. Format: YYYY-MM-DD HH:MM:SS"
},
"created_by_user_id": {
"type": "integer",
"description": "The ID of the user who created the team"
}
}
}
],
"title": "updateTeamWithAdditionalProperties"
}
],
"title": "baseTeam"
}
}
}
],
"title": "teamResponse200"
}
LegacyTeamsAddUsersToTeam403Response
{
"type": "object",
"title": "failResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
LegacyTeamsAddUsersToTeam404Response
{
"type": "object",
"title": "failResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
LegacyTeamsAddUsersToTeamRequest
{
"type": "object",
"title": "addTeamUserRequest",
"required": [
"users"
],
"properties": {
"users": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The list of user IDs"
}
}
}
LegacyTeamsAddUsersToTeamResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The list of user IDs"
}
}
}
],
"title": "userIds"
}
LegacyTeamsGetAllTeamsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"type": "object",
"title": "teamId",
"properties": {
"id": {
"type": "integer",
"description": "The team ID"
}
}
},
{
"type": "object",
"allOf": [
{
"allOf": [
{
"type": "object",
"title": "addTeamRequest",
"properties": {
"name": {
"type": "string",
"description": "The team name"
},
"users": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The list of user IDs"
},
"manager_id": {
"type": "integer",
"description": "The team manager ID"
},
"description": {
"type": "string",
"description": "The team description"
}
}
},
{
"type": "object",
"properties": {
"active_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Flag that indicates whether the team is active"
},
"deleted_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Flag that indicates whether the team is deleted"
}
}
}
],
"title": "updateTeamRequest"
},
{
"type": "object",
"title": "baseTeamAdditionalProperties",
"properties": {
"add_time": {
"type": "string",
"description": "The team creation time. Format: YYYY-MM-DD HH:MM:SS"
},
"created_by_user_id": {
"type": "integer",
"description": "The ID of the user who created the team"
}
}
}
],
"title": "updateTeamWithAdditionalProperties"
}
],
"title": "baseTeam"
}
}
}
}
],
"title": "teamsResponse200"
}
LegacyTeamsGetAllUsers404Response
{
"type": "object",
"title": "failResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
LegacyTeamsGetAllUsersResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The list of user IDs"
}
}
}
],
"title": "userIds"
}
LegacyTeamsGetData404Response
{
"type": "object",
"title": "failResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
LegacyTeamsGetDataResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"allOf": [
{
"type": "object",
"title": "teamId",
"properties": {
"id": {
"type": "integer",
"description": "The team ID"
}
}
},
{
"type": "object",
"allOf": [
{
"allOf": [
{
"type": "object",
"title": "addTeamRequest",
"properties": {
"name": {
"type": "string",
"description": "The team name"
},
"users": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The list of user IDs"
},
"manager_id": {
"type": "integer",
"description": "The team manager ID"
},
"description": {
"type": "string",
"description": "The team description"
}
}
},
{
"type": "object",
"properties": {
"active_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Flag that indicates whether the team is active"
},
"deleted_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Flag that indicates whether the team is deleted"
}
}
}
],
"title": "updateTeamRequest"
},
{
"type": "object",
"title": "baseTeamAdditionalProperties",
"properties": {
"add_time": {
"type": "string",
"description": "The team creation time. Format: YYYY-MM-DD HH:MM:SS"
},
"created_by_user_id": {
"type": "integer",
"description": "The ID of the user who created the team"
}
}
}
],
"title": "updateTeamWithAdditionalProperties"
}
],
"title": "baseTeam"
}
}
}
],
"title": "teamResponse200"
}
LegacyTeamsGetUserTeamsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"type": "object",
"title": "teamId",
"properties": {
"id": {
"type": "integer",
"description": "The team ID"
}
}
},
{
"type": "object",
"allOf": [
{
"allOf": [
{
"type": "object",
"title": "addTeamRequest",
"properties": {
"name": {
"type": "string",
"description": "The team name"
},
"users": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The list of user IDs"
},
"manager_id": {
"type": "integer",
"description": "The team manager ID"
},
"description": {
"type": "string",
"description": "The team description"
}
}
},
{
"type": "object",
"properties": {
"active_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Flag that indicates whether the team is active"
},
"deleted_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Flag that indicates whether the team is deleted"
}
}
}
],
"title": "updateTeamRequest"
},
{
"type": "object",
"title": "baseTeamAdditionalProperties",
"properties": {
"add_time": {
"type": "string",
"description": "The team creation time. Format: YYYY-MM-DD HH:MM:SS"
},
"created_by_user_id": {
"type": "integer",
"description": "The ID of the user who created the team"
}
}
}
],
"title": "updateTeamWithAdditionalProperties"
}
],
"title": "baseTeam"
}
}
}
}
],
"title": "teamsResponse200"
}
LegacyTeamsRemoveUsers403Response
{
"type": "object",
"title": "failResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
LegacyTeamsRemoveUsers404Response
{
"type": "object",
"title": "failResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
LegacyTeamsRemoveUsersRequest
{
"type": "object",
"title": "deleteTeamUserRequest",
"required": [
"users"
],
"properties": {
"users": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The list of user IDs"
}
}
}
LegacyTeamsRemoveUsersResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The list of user IDs"
}
}
}
],
"title": "userIds"
}
LegacyTeamsUpdateTeamObject403Response
{
"type": "object",
"title": "failResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
LegacyTeamsUpdateTeamObject404Response
{
"type": "object",
"title": "failResponse",
"properties": {
"error": {
"type": "string",
"description": "The error message"
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
}
LegacyTeamsUpdateTeamObjectRequest
{
"allOf": [
{
"type": "object",
"title": "addTeamRequest",
"properties": {
"name": {
"type": "string",
"description": "The team name"
},
"users": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The list of user IDs"
},
"manager_id": {
"type": "integer",
"description": "The team manager ID"
},
"description": {
"type": "string",
"description": "The team description"
}
}
},
{
"type": "object",
"properties": {
"active_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Flag that indicates whether the team is active"
},
"deleted_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Flag that indicates whether the team is deleted"
}
}
}
],
"title": "updateTeamRequest"
}
LegacyTeamsUpdateTeamObjectResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"allOf": [
{
"type": "object",
"title": "teamId",
"properties": {
"id": {
"type": "integer",
"description": "The team ID"
}
}
},
{
"type": "object",
"allOf": [
{
"allOf": [
{
"type": "object",
"title": "addTeamRequest",
"properties": {
"name": {
"type": "string",
"description": "The team name"
},
"users": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The list of user IDs"
},
"manager_id": {
"type": "integer",
"description": "The team manager ID"
},
"description": {
"type": "string",
"description": "The team description"
}
}
},
{
"type": "object",
"properties": {
"active_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Flag that indicates whether the team is active"
},
"deleted_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Flag that indicates whether the team is deleted"
}
}
}
],
"title": "updateTeamRequest"
},
{
"type": "object",
"title": "baseTeamAdditionalProperties",
"properties": {
"add_time": {
"type": "string",
"description": "The team creation time. Format: YYYY-MM-DD HH:MM:SS"
},
"created_by_user_id": {
"type": "integer",
"description": "The ID of the user who created the team"
}
}
}
],
"title": "updateTeamWithAdditionalProperties"
}
],
"title": "baseTeam"
}
}
}
],
"title": "teamResponse200"
}
MailboxGetAllMailMessagesResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail thread"
},
"snippet": {
"type": "string",
"description": "A snippet"
},
"subject": {
"type": "string",
"description": "The subject"
},
"user_id": {
"type": "integer",
"description": "ID of the user whom mail message will be assigned to"
},
"read_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is read"
},
"account_id": {
"type": "string",
"description": "The connection account ID"
},
"synced_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is synced"
},
"deleted_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is deleted"
},
"smart_bcc_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether one of the parties of the mail thread is Bcc"
},
"has_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has an attachment"
},
"mail_tracking_status": {
"type": "string",
"nullable": true,
"description": "Mail tracking status"
},
"has_real_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has real attachments (which are not inline)"
},
"has_inline_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has inline attachments"
},
"mail_link_tracking_enabled_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the link tracking of the mail thread is enabled"
}
}
},
{
"type": "object",
"properties": {
"cc": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail thread participant"
},
"name": {
"type": "string",
"description": "Name of the mail thread participant"
},
"latest_sent": {
"type": "boolean",
"description": "Whether the mail thread participant was last to send an email"
},
"message_time": {
"type": "number",
"description": "Message time"
},
"email_address": {
"type": "string",
"description": "Email address of the mail thread participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person"
},
"linked_person_name": {
"type": "string",
"description": "Email of the linked person"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message party"
},
"linked_organization_id": {
"type": "integer",
"nullable": true,
"description": "Linked Organization ID"
}
},
"description": "Member of a thread"
},
"description": "Participants of the Cc"
},
"to": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail thread participant"
},
"name": {
"type": "string",
"description": "Name of the mail thread participant"
},
"latest_sent": {
"type": "boolean",
"description": "Whether the mail thread participant was last to send an email"
},
"message_time": {
"type": "number",
"description": "Message time"
},
"email_address": {
"type": "string",
"description": "Email address of the mail thread participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person"
},
"linked_person_name": {
"type": "string",
"description": "Email of the linked person"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message party"
},
"linked_organization_id": {
"type": "integer",
"nullable": true,
"description": "Linked Organization ID"
}
},
"description": "Member of a thread"
},
"description": "Recipients of the mail thread"
},
"bcc": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail thread participant"
},
"name": {
"type": "string",
"description": "Name of the mail thread participant"
},
"latest_sent": {
"type": "boolean",
"description": "Whether the mail thread participant was last to send an email"
},
"message_time": {
"type": "number",
"description": "Message time"
},
"email_address": {
"type": "string",
"description": "Email address of the mail thread participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person"
},
"linked_person_name": {
"type": "string",
"description": "Email of the linked person"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message party"
},
"linked_organization_id": {
"type": "integer",
"nullable": true,
"description": "Linked Organization ID"
}
},
"description": "Member of a thread"
},
"description": "Participants of the Bcc"
},
"from": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail thread participant"
},
"name": {
"type": "string",
"description": "Name of the mail thread participant"
},
"latest_sent": {
"type": "boolean",
"description": "Whether the mail thread participant was last to send an email"
},
"message_time": {
"type": "number",
"description": "Message time"
},
"email_address": {
"type": "string",
"description": "Email address of the mail thread participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person"
},
"linked_person_name": {
"type": "string",
"description": "Email of the linked person"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message party"
},
"linked_organization_id": {
"type": "integer",
"nullable": true,
"description": "Linked Organization ID"
}
},
"description": "Member of a thread"
},
"description": "Senders of the mail thread"
},
"draft": {
"type": "string",
"nullable": true,
"description": "If the mail message has a draft status then the value is the mail message object as JSON formatted string, otherwise `null`."
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The time when the mail message was inserted to database"
},
"body_url": {
"type": "string",
"description": "A link to the mail thread message"
},
"sent_flag": {
"type": "number",
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread message is sent"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The time when the mail message was updated in database received"
},
"message_time": {
"type": "string",
"format": "date-time",
"description": "The time when the mail message was received or created"
},
"has_body_flag": {
"type": "number",
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread message has a body"
},
"mail_thread_id": {
"type": "integer",
"description": "ID of the mail thread"
},
"sent_from_pipedrive_flag": {
"type": "number",
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread message is sent from Pipedrive"
}
}
}
]
},
"description": "The array of the mail messages of the mail thread"
}
}
}
],
"title": "getAllMailMessagesOfMailThreadResponse200"
}
MailboxGetMailMessageResponse
{
"allOf": [
{
"type": "object",
"properties": {
"service": {
"type": "string",
"description": "The service name of the response."
},
"success": {
"type": "boolean",
"description": "If the response is successful or not"
},
"statusCode": {
"type": "integer",
"description": "The email service specific status code and it is returned through the response body."
},
"statusText": {
"type": "string",
"description": "The status text of the response."
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"cc": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail participant"
},
"name": {
"type": "string",
"description": "Name of the mail participant"
},
"email_address": {
"type": "string",
"description": "Mail address of the mail participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person to the mail message"
},
"linked_person_name": {
"type": "string",
"description": "Name of the linked person to the mail message"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message participant"
}
}
},
"description": "The array of mail message copies (object)"
},
"id": {
"type": "integer",
"description": "ID of the mail message."
},
"to": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail participant"
},
"name": {
"type": "string",
"description": "Name of the mail participant"
},
"email_address": {
"type": "string",
"description": "Mail address of the mail participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person to the mail message"
},
"linked_person_name": {
"type": "string",
"description": "Name of the linked person to the mail message"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message participant"
}
}
},
"description": "The array of mail message receiver (object)"
},
"bcc": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail participant"
},
"name": {
"type": "string",
"description": "Name of the mail participant"
},
"email_address": {
"type": "string",
"description": "Mail address of the mail participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person to the mail message"
},
"linked_person_name": {
"type": "string",
"description": "Name of the linked person to the mail message"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message participant"
}
}
},
"description": "The array of mail message blind copies (object)"
},
"from": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail participant"
},
"name": {
"type": "string",
"description": "Name of the mail participant"
},
"email_address": {
"type": "string",
"description": "Mail address of the mail participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person to the mail message"
},
"linked_person_name": {
"type": "string",
"description": "Name of the linked person to the mail message"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message participant"
}
}
},
"description": "The array of mail message sender (object)"
},
"draft": {
"type": "string",
"description": "If the mail message has a draft status then the value is the mail message object as JSON formatted string, otherwise `null`."
},
"snippet": {
"type": "string",
"description": "The snippet of mail message. Snippet length is up to 225 characters."
},
"subject": {
"type": "string",
"description": "The subject of mail message"
},
"user_id": {
"type": "integer",
"description": "ID of the user whom mail message will be assigned to"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The insertion into the database time of the mail message"
},
"body_url": {
"type": "string",
"description": "The mail message body URL"
},
"read_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message is read or not by the user"
},
"sent_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message has been sent or not"
},
"account_id": {
"type": "string",
"description": "The connection account ID"
},
"draft_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message is a draft or not"
},
"synced_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message is synced with the provider or not"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The updating time in the database of the mail message"
},
"deleted_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message is deleted or not"
},
"message_time": {
"type": "string",
"format": "date-time",
"description": "Creation or receival time of the mail message"
},
"has_body_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message has a body or not"
},
"mail_thread_id": {
"type": "integer",
"description": "ID of the mail message thread"
},
"smart_bcc_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message has been created by Smart Email BCC feature or not"
},
"has_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message has an attachment or not"
},
"mail_tracking_status": {
"enum": [
"opened",
"not opened"
],
"type": "string",
"nullable": true,
"description": "The status of tracking mail message. Value is `null` if tracking is not enabled."
},
"sent_from_pipedrive_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message has been sent from Pipedrive app or not"
},
"has_real_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message has an attachment (which is not inline) or not"
},
"has_inline_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail message has an inline attachment or not"
},
"mail_link_tracking_enabled_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the link tracking in mail message body is enabled."
}
}
}
}
}
],
"title": "mailMessageResponse200"
}
MailboxGetMailThreadResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail thread"
},
"snippet": {
"type": "string",
"description": "A snippet"
},
"subject": {
"type": "string",
"description": "The subject"
},
"user_id": {
"type": "integer",
"description": "ID of the user whom mail message will be assigned to"
},
"read_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is read"
},
"account_id": {
"type": "string",
"description": "The connection account ID"
},
"synced_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is synced"
},
"deleted_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is deleted"
},
"smart_bcc_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether one of the parties of the mail thread is Bcc"
},
"has_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has an attachment"
},
"mail_tracking_status": {
"type": "string",
"nullable": true,
"description": "Mail tracking status"
},
"has_real_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has real attachments (which are not inline)"
},
"has_inline_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has inline attachments"
},
"mail_link_tracking_enabled_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the link tracking of the mail thread is enabled"
}
}
},
{
"type": "object",
"properties": {
"deal_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the deal"
},
"folders": {
"type": "array",
"items": {
"type": "string"
},
"description": "Folders in which messages from thread are being stored"
},
"lead_id": {
"type": "string",
"format": "uuid",
"nullable": true,
"description": "The ID of the lead"
},
"parties": {
"type": "object",
"properties": {
"to": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail thread participant"
},
"name": {
"type": "string",
"description": "Name of the mail thread participant"
},
"latest_sent": {
"type": "boolean",
"description": "Whether the mail thread participant was last to send an email"
},
"message_time": {
"type": "number",
"description": "Message time"
},
"email_address": {
"type": "string",
"description": "Email address of the mail thread participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person"
},
"linked_person_name": {
"type": "string",
"description": "Email of the linked person"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message party"
},
"linked_organization_id": {
"type": "integer",
"nullable": true,
"description": "Linked Organization ID"
}
},
"description": "Member of a thread"
},
"description": "Recipients of the mail thread"
},
"from": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail thread participant"
},
"name": {
"type": "string",
"description": "Name of the mail thread participant"
},
"latest_sent": {
"type": "boolean",
"description": "Whether the mail thread participant was last to send an email"
},
"message_time": {
"type": "number",
"description": "Message time"
},
"email_address": {
"type": "string",
"description": "Email address of the mail thread participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person"
},
"linked_person_name": {
"type": "string",
"description": "Email of the linked person"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message party"
},
"linked_organization_id": {
"type": "integer",
"nullable": true,
"description": "Linked Organization ID"
}
},
"description": "Member of a thread"
},
"description": "Senders of the mail thread"
}
},
"description": "Parties of the mail thread"
},
"version": {
"type": "number",
"description": "Version"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The time when the mail thread was inserted to database"
},
"deal_status": {
"type": "string",
"nullable": true,
"description": "Status of the deal"
},
"shared_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is shared"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The time when the mail thread was updated in database received"
},
"snippet_sent": {
"type": "string",
"description": "A snippet from a message sent"
},
"archived_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is archived"
},
"has_sent_flag": {
"type": "number",
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has messages sent"
},
"message_count": {
"type": "integer",
"description": "An amount of messages"
},
"snippet_draft": {
"type": "string",
"nullable": true,
"description": "A snippet from a draft"
},
"drafts_parties": {
"type": "array",
"items": {
"type": "object"
},
"description": "Parties of the drafted mail thread"
},
"has_draft_flag": {
"type": "number",
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has any drafts"
},
"external_deleted_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has been deleted externally"
},
"all_messages_sent_flag": {
"type": "number",
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether all the mail thread messages have been sent"
},
"last_message_timestamp": {
"type": "string",
"format": "date-time",
"description": "Last message timestamp"
},
"first_message_timestamp": {
"type": "string",
"format": "date-time",
"description": "The time when the mail thread has had the first message received or created"
},
"first_message_to_me_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread was initialized by others"
},
"last_message_sent_timestamp": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The last time when the mail thread has had a message sent"
},
"last_message_received_timestamp": {
"type": "string",
"format": "date-time",
"description": "The last time when the mail thread has had a message received"
}
}
}
],
"title": "baseMailThread"
}
],
"description": "The mail thread object"
}
}
}
],
"title": "getOneMailThreadResponse200"
}
MailboxGetMailThreadsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail thread"
},
"snippet": {
"type": "string",
"description": "A snippet"
},
"subject": {
"type": "string",
"description": "The subject"
},
"user_id": {
"type": "integer",
"description": "ID of the user whom mail message will be assigned to"
},
"read_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is read"
},
"account_id": {
"type": "string",
"description": "The connection account ID"
},
"synced_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is synced"
},
"deleted_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is deleted"
},
"smart_bcc_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether one of the parties of the mail thread is Bcc"
},
"has_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has an attachment"
},
"mail_tracking_status": {
"type": "string",
"nullable": true,
"description": "Mail tracking status"
},
"has_real_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has real attachments (which are not inline)"
},
"has_inline_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has inline attachments"
},
"mail_link_tracking_enabled_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the link tracking of the mail thread is enabled"
}
}
},
{
"type": "object",
"properties": {
"deal_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the deal"
},
"folders": {
"type": "array",
"items": {
"type": "string"
},
"description": "Folders in which messages from thread are being stored"
},
"lead_id": {
"type": "string",
"format": "uuid",
"nullable": true,
"description": "The ID of the lead"
},
"parties": {
"type": "object",
"properties": {
"to": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail thread participant"
},
"name": {
"type": "string",
"description": "Name of the mail thread participant"
},
"latest_sent": {
"type": "boolean",
"description": "Whether the mail thread participant was last to send an email"
},
"message_time": {
"type": "number",
"description": "Message time"
},
"email_address": {
"type": "string",
"description": "Email address of the mail thread participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person"
},
"linked_person_name": {
"type": "string",
"description": "Email of the linked person"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message party"
},
"linked_organization_id": {
"type": "integer",
"nullable": true,
"description": "Linked Organization ID"
}
},
"description": "Member of a thread"
},
"description": "Recipients of the mail thread"
},
"from": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail thread participant"
},
"name": {
"type": "string",
"description": "Name of the mail thread participant"
},
"latest_sent": {
"type": "boolean",
"description": "Whether the mail thread participant was last to send an email"
},
"message_time": {
"type": "number",
"description": "Message time"
},
"email_address": {
"type": "string",
"description": "Email address of the mail thread participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person"
},
"linked_person_name": {
"type": "string",
"description": "Email of the linked person"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message party"
},
"linked_organization_id": {
"type": "integer",
"nullable": true,
"description": "Linked Organization ID"
}
},
"description": "Member of a thread"
},
"description": "Senders of the mail thread"
}
},
"description": "Parties of the mail thread"
},
"version": {
"type": "number",
"description": "Version"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The time when the mail thread was inserted to database"
},
"deal_status": {
"type": "string",
"nullable": true,
"description": "Status of the deal"
},
"shared_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is shared"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The time when the mail thread was updated in database received"
},
"snippet_sent": {
"type": "string",
"description": "A snippet from a message sent"
},
"archived_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is archived"
},
"has_sent_flag": {
"type": "number",
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has messages sent"
},
"message_count": {
"type": "integer",
"description": "An amount of messages"
},
"snippet_draft": {
"type": "string",
"nullable": true,
"description": "A snippet from a draft"
},
"drafts_parties": {
"type": "array",
"items": {
"type": "object"
},
"description": "Parties of the drafted mail thread"
},
"has_draft_flag": {
"type": "number",
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has any drafts"
},
"external_deleted_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has been deleted externally"
},
"all_messages_sent_flag": {
"type": "number",
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether all the mail thread messages have been sent"
},
"last_message_timestamp": {
"type": "string",
"format": "date-time",
"description": "Last message timestamp"
},
"first_message_timestamp": {
"type": "string",
"format": "date-time",
"description": "The time when the mail thread has had the first message received or created"
},
"first_message_to_me_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread was initialized by others"
},
"last_message_sent_timestamp": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The last time when the mail thread has had a message sent"
},
"last_message_received_timestamp": {
"type": "string",
"format": "date-time",
"description": "The last time when the mail thread has had a message received"
}
}
}
],
"title": "baseMailThread"
},
"description": "The array of mail threads"
}
}
}
],
"title": "getMailThreadsResponse200"
}
MailboxMarkThreadDeletedResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the deleted mail thread"
}
}
}
}
}
],
"title": "deleteMailThreadResponse200"
}
MailboxUpdateMailThreadDetailsRequest
{
"type": "object",
"title": "updateMailThreadDetailsRequest",
"properties": {
"deal_id": {
"type": "integer",
"description": "The ID of the deal this thread is associated with"
},
"lead_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the lead this thread is associated with"
},
"read_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Whether this thread is read or unread"
},
"shared_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Whether this thread is shared with other users in your company"
},
"archived_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "Whether this thread is archived or not. You can only archive threads that belong to Inbox folder. Archived threads will disappear from Inbox."
}
}
}
MailboxUpdateMailThreadDetailsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail thread"
},
"snippet": {
"type": "string",
"description": "A snippet"
},
"subject": {
"type": "string",
"description": "The subject"
},
"user_id": {
"type": "integer",
"description": "ID of the user whom mail message will be assigned to"
},
"read_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is read"
},
"account_id": {
"type": "string",
"description": "The connection account ID"
},
"synced_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is synced"
},
"deleted_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is deleted"
},
"smart_bcc_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether one of the parties of the mail thread is Bcc"
},
"has_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has an attachment"
},
"mail_tracking_status": {
"type": "string",
"nullable": true,
"description": "Mail tracking status"
},
"has_real_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has real attachments (which are not inline)"
},
"has_inline_attachments_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has inline attachments"
},
"mail_link_tracking_enabled_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the link tracking of the mail thread is enabled"
}
}
},
{
"type": "object",
"properties": {
"deal_id": {
"type": "integer",
"nullable": true,
"description": "The ID of the deal"
},
"folders": {
"type": "array",
"items": {
"type": "string"
},
"description": "Folders in which messages from thread are being stored"
},
"lead_id": {
"type": "string",
"format": "uuid",
"nullable": true,
"description": "The ID of the lead"
},
"parties": {
"type": "object",
"properties": {
"to": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail thread participant"
},
"name": {
"type": "string",
"description": "Name of the mail thread participant"
},
"latest_sent": {
"type": "boolean",
"description": "Whether the mail thread participant was last to send an email"
},
"message_time": {
"type": "number",
"description": "Message time"
},
"email_address": {
"type": "string",
"description": "Email address of the mail thread participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person"
},
"linked_person_name": {
"type": "string",
"description": "Email of the linked person"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message party"
},
"linked_organization_id": {
"type": "integer",
"nullable": true,
"description": "Linked Organization ID"
}
},
"description": "Member of a thread"
},
"description": "Recipients of the mail thread"
},
"from": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the mail thread participant"
},
"name": {
"type": "string",
"description": "Name of the mail thread participant"
},
"latest_sent": {
"type": "boolean",
"description": "Whether the mail thread participant was last to send an email"
},
"message_time": {
"type": "number",
"description": "Message time"
},
"email_address": {
"type": "string",
"description": "Email address of the mail thread participant"
},
"linked_person_id": {
"type": "integer",
"description": "ID of the linked person"
},
"linked_person_name": {
"type": "string",
"description": "Email of the linked person"
},
"mail_message_party_id": {
"type": "integer",
"description": "ID of the mail message party"
},
"linked_organization_id": {
"type": "integer",
"nullable": true,
"description": "Linked Organization ID"
}
},
"description": "Member of a thread"
},
"description": "Senders of the mail thread"
}
},
"description": "Parties of the mail thread"
},
"version": {
"type": "number",
"description": "Version"
},
"add_time": {
"type": "string",
"format": "date-time",
"description": "The time when the mail thread was inserted to database"
},
"deal_status": {
"type": "string",
"nullable": true,
"description": "Status of the deal"
},
"shared_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is shared"
},
"update_time": {
"type": "string",
"format": "date-time",
"description": "The time when the mail thread was updated in database received"
},
"snippet_sent": {
"type": "string",
"description": "A snippet from a message sent"
},
"archived_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread is archived"
},
"has_sent_flag": {
"type": "number",
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has messages sent"
},
"message_count": {
"type": "integer",
"description": "An amount of messages"
},
"snippet_draft": {
"type": "string",
"nullable": true,
"description": "A snippet from a draft"
},
"drafts_parties": {
"type": "array",
"items": {
"type": "object"
},
"description": "Parties of the drafted mail thread"
},
"has_draft_flag": {
"type": "number",
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has any drafts"
},
"external_deleted_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread has been deleted externally"
},
"all_messages_sent_flag": {
"type": "number",
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether all the mail thread messages have been sent"
},
"last_message_timestamp": {
"type": "string",
"format": "date-time",
"description": "Last message timestamp"
},
"first_message_timestamp": {
"type": "string",
"format": "date-time",
"description": "The time when the mail thread has had the first message received or created"
},
"first_message_to_me_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBooleanDefault0",
"default": 0
}
],
"description": "Whether the mail thread was initialized by others"
},
"last_message_sent_timestamp": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The last time when the mail thread has had a message sent"
},
"last_message_received_timestamp": {
"type": "string",
"format": "date-time",
"description": "The last time when the mail thread has had a message received"
}
}
}
],
"title": "baseMailThread",
"description": "The mail thread object"
}
}
}
],
"title": "updateMailThreadDetailsResponse200"
}
MeetingsLinkUserProvider401Response
{
"type": "object",
"title": "userProviderLinkErrorResponse",
"properties": {
"message": {
"type": "string",
"example": "Missing user id or company id",
"description": "The error message of the request"
},
"success": {
"type": "boolean",
"description": "Boolean that indicates whether the request was successful or not"
}
}
}
MeetingsLinkUserProviderRequest
{
"type": "object",
"title": "addUserProviderLinkRequest",
"required": [
"user_provider_id",
"user_id",
"company_id",
"marketplace_client_id"
],
"properties": {
"user_id": {
"type": "integer",
"example": 123,
"description": "Pipedrive user ID"
},
"company_id": {
"type": "integer",
"example": 456,
"description": "Pipedrive company ID"
},
"user_provider_id": {
"type": "string",
"format": "uuid",
"example": "1e3943c9-6395-462b-b432-1f252c017f3d",
"description": "Unique identifier linking a user to the installed integration. Generated by the integration."
},
"marketplace_client_id": {
"type": "string",
"example": "57da5c3c55a82bb4",
"description": "Pipedrive Marketplace client ID of the installed integration"
}
}
}
MeetingsLinkUserProviderResponse
{
"type": "object",
"title": "userProviderLinkSuccessResponse",
"properties": {
"data": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "The user was added successfully",
"description": "The success message of the request"
}
}
},
"success": {
"type": "boolean",
"description": "Boolean that indicates whether the request was successful or not"
}
}
}
MeetingsRemoveUserProviderLink401Response
{
"type": "object",
"title": "userProviderLinkErrorResponse",
"properties": {
"message": {
"type": "string",
"example": "Missing user id or company id",
"description": "The error message of the request"
},
"success": {
"type": "boolean",
"description": "Boolean that indicates whether the request was successful or not"
}
}
}
MeetingsRemoveUserProviderLink403Response
{
"type": "object",
"title": "userProviderLinkErrorResponse",
"properties": {
"message": {
"type": "string",
"example": "Missing user id or company id",
"description": "The error message of the request"
},
"success": {
"type": "boolean",
"description": "Boolean that indicates whether the request was successful or not"
}
}
}
MeetingsRemoveUserProviderLinkResponse
{
"type": "object",
"title": "userProviderLinkSuccessResponse",
"properties": {
"data": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "The user was added successfully",
"description": "The success message of the request"
}
}
},
"success": {
"type": "boolean",
"description": "Boolean that indicates whether the request was successful or not"
}
}
}
NoteFieldsGetAllNoteFieldsResponse
{
"allOf": [
{
"type": "object",
"title": "baseResponse",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the field"
},
"key": {
"type": "string",
"description": "The key of the field"
},
"name": {
"type": "string",
"description": "The name of the field"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"label": {
"type": "string"
}
}
},
"description": "The options of the field. When there are no options, `null` is returned."
},
"edit_flag": {
"type": "boolean",
"description": "The edit flag of the field"
},
"field_type": {
"enum": [
"address",
"date",
"daterange",
"double",
"enum",
"monetary",
"org",
"people",
"phone",
"set",
"text",
"time",
"timerange",
"user",
"varchar",
"varchar_auto",
"visible_to"
],
"type": "string",
"description": "The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`address`</td><td>Address field (has multiple subfields, autocompleted by Google Maps)</td></tr><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td></tr><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td></tr><tr><td>`double`</td><td>Numeric value</td></tr><tr><td>`enum`</td><td>Options field with a single possible chosen option</td></tr><tr></tr><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td></tr><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td></tr><tr><td>`people`</td><td>Person field (contains a person ID which is stored on the same account)</td></tr><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td></tr><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td></tr><tr><td>`text`</td><td>Long text (up to 65k characters)</td></tr><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td></tr><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td></tr><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td></tr><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td></tr><tr><td>`visible_to`</td><td>System field that keeps item's visibility setting</td></tr></table>"
},
"active_flag": {
"type": "boolean",
"description": "The active flag of the field"
},
"mandatory_flag": {
"type": "boolean",
"description": "Whether or not the field is mandatory"
},
"bulk_edit_allowed": {
"type": "boolean",
"description": "Not used"
}
}
}
},
"additional_data": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Items shown per page"
},
"start": {
"type": "integer",
"description": "Pagination start"
},
"more_items_in_collection": {
"type": "boolean",
"description": "If there are more list items in the collection than displayed or not"
}
},
"description": "The additional data of the list"
}
}
}
],
"title": "getNoteFieldsResponse200"
}
NotesAddNewCommentRequest
{
"type": "object",
"title": "CommentPostPutObject",
"required": [
"content"
],
"properties": {
"content": {
"type": "string",
"description": "The content of the comment in HTML format. Subject to sanitization on the back-end."
}
}
}
NotesAddNewCommentResponse
{
"type": "object",
"title": "oneCommentResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"format": "uuid",
"description": "The ID of the note"
},
"content": {
"type": "string",
"description": "The content of the note in HTML format. Subject to sanitization on the back-end."
},
"user_id": {
"type": "integer",
"description": "The ID of the user who created the comment"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the note"
},
"object_id": {
"type": "string",
"description": "The ID of the object that the comment is attached to, will be the id of the note"
},
"company_id": {
"type": "integer",
"description": "The ID of the company"
},
"updater_id": {
"type": "integer",
"description": "The ID of the user who last updated the comment"
},
"active_flag": {
"type": "boolean",
"description": "Whether the note is active or deleted"
},
"object_type": {
"type": "string",
"description": "The type of object that the comment is attached to, will be \"note\""
},
"update_time": {
"type": "string",
"description": "The creation date and time of the note"
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
NotesCreateNoteRequest
{
"allOf": [
{
"type": "object",
"required": [
"content"
],
"properties": {
"org_id": {
"type": "integer",
"description": "The ID of the organization this note will be attached to. This property is required unless one of (`deal_id/lead_id/person_id`) is specified."
},
"content": {
"type": "string",
"description": "The content of the note in HTML format. Subject to sanitization on the back-end."
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal the note will be attached to. This property is required unless one of (`lead_id/person_id/org_id`) is specified."
},
"lead_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the lead the note will be attached to. This property is required unless one of (`deal_id/person_id/org_id`) is specified."
},
"person_id": {
"type": "integer",
"description": "The ID of the person this note will be attached to. This property is required unless one of (`deal_id/lead_id/org_id`) is specified."
}
}
},
{
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"description": "The ID of the user who will be marked as the author of the note. Only an admin can change the author."
},
"add_time": {
"type": "string",
"description": "The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS"
},
"pinned_to_deal_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "If set, the results are filtered by note to deal pinning state (`deal_id` is also required)"
},
"pinned_to_lead_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "If set, the results are filtered by note to lead pinning state (`lead_id` is also required)"
},
"pinned_to_person_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "If set, the results are filtered by note to person pinning state (`person_id` is also required)"
},
"pinned_to_organization_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "If set, the results are filtered by note to organization pinning state (`org_id` is also required)"
}
}
}
]
}
NotesCreateNoteResponse
{
"type": "object",
"title": "oneNoteResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the note"
},
"deal": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the deal this note is attached to"
}
},
"description": "The deal this note is attached to"
},
"user": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the note creator"
},
"email": {
"type": "string",
"description": "The email of the note creator"
},
"is_you": {
"type": "boolean",
"description": "Whether the note is created by you or not"
},
"icon_url": {
"type": "string",
"description": "The URL of the note creator avatar picture"
}
},
"description": "The user who created the note"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization the note is attached to"
},
"person": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the person the note is attached to"
}
},
"description": "The person the note is attached to"
},
"content": {
"type": "string",
"description": "The content of the note in HTML format. Subject to sanitization on the back-end."
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal the note is attached to"
},
"lead_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the lead the note is attached to"
},
"user_id": {
"type": "integer",
"description": "The ID of the note creator"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the note"
},
"person_id": {
"type": "integer",
"description": "The ID of the person the note is attached to"
},
"active_flag": {
"type": "boolean",
"description": "Whether the note is active or deleted"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the note"
},
"organization": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the organization the note is attached to"
}
},
"description": "The organization the note is attached to"
},
"last_update_user_id": {
"type": "integer",
"description": "The ID of the user who last updated the note"
},
"pinned_to_deal_flag": {
"type": "boolean",
"description": "If true, the results are filtered by note to deal pinning state"
},
"pinned_to_person_flag": {
"type": "boolean",
"description": "If true, the results are filtered by note to person pinning state"
},
"pinned_to_organization_flag": {
"type": "boolean",
"description": "If true, the results are filtered by note to organization pinning state"
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
NotesDeleteCommentResponse
{
"type": "object",
"title": "deleteCommentResponse200",
"properties": {
"data": {
"type": "boolean",
"description": "If the response is successful or not"
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
NotesDeleteNoteResponse
{
"type": "object",
"title": "deleteNoteResponse200",
"properties": {
"data": {
"type": "boolean",
"description": "If the response is successful or not"
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
NotesGetAllCommentsResponse
{
"type": "object",
"title": "getCommentsResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"format": "uuid",
"description": "The ID of the note"
},
"content": {
"type": "string",
"description": "The content of the note in HTML format. Subject to sanitization on the back-end."
},
"user_id": {
"type": "integer",
"description": "The ID of the user who created the comment"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the note"
},
"object_id": {
"type": "string",
"description": "The ID of the object that the comment is attached to, will be the id of the note"
},
"company_id": {
"type": "integer",
"description": "The ID of the company"
},
"updater_id": {
"type": "integer",
"description": "The ID of the user who last updated the comment"
},
"active_flag": {
"type": "boolean",
"description": "Whether the note is active or deleted"
},
"object_type": {
"type": "string",
"description": "The type of object that the comment is attached to, will be \"note\""
},
"update_time": {
"type": "string",
"description": "The creation date and time of the note"
}
}
},
"description": "The array of comments"
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
},
"additional_data": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Items shown per page"
},
"start": {
"type": "integer",
"description": "Pagination start"
},
"more_items_in_collection": {
"type": "boolean",
"description": "If there are more list items in the collection than displayed or not"
}
},
"description": "The additional data of the list"
},
{
"type": "object",
"properties": {
"next_start": {
"type": "integer",
"description": "Next pagination start"
}
}
}
],
"description": "The pagination details of the list"
}
}
}
}
}
NotesGetAllResponse
{
"type": "object",
"title": "getNotesResponse200",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the note"
},
"deal": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the deal this note is attached to"
}
},
"description": "The deal this note is attached to"
},
"user": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the note creator"
},
"email": {
"type": "string",
"description": "The email of the note creator"
},
"is_you": {
"type": "boolean",
"description": "Whether the note is created by you or not"
},
"icon_url": {
"type": "string",
"description": "The URL of the note creator avatar picture"
}
},
"description": "The user who created the note"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization the note is attached to"
},
"person": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the person the note is attached to"
}
},
"description": "The person the note is attached to"
},
"content": {
"type": "string",
"description": "The content of the note in HTML format. Subject to sanitization on the back-end."
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal the note is attached to"
},
"lead_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the lead the note is attached to"
},
"user_id": {
"type": "integer",
"description": "The ID of the note creator"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the note"
},
"person_id": {
"type": "integer",
"description": "The ID of the person the note is attached to"
},
"active_flag": {
"type": "boolean",
"description": "Whether the note is active or deleted"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the note"
},
"organization": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the organization the note is attached to"
}
},
"description": "The organization the note is attached to"
},
"last_update_user_id": {
"type": "integer",
"description": "The ID of the user who last updated the note"
},
"pinned_to_deal_flag": {
"type": "boolean",
"description": "If true, the results are filtered by note to deal pinning state"
},
"pinned_to_person_flag": {
"type": "boolean",
"description": "If true, the results are filtered by note to person pinning state"
},
"pinned_to_organization_flag": {
"type": "boolean",
"description": "If true, the results are filtered by note to organization pinning state"
}
}
},
"description": "The array of notes"
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
},
"additional_data": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Items shown per page"
},
"start": {
"type": "integer",
"description": "Pagination start"
},
"more_items_in_collection": {
"type": "boolean",
"description": "If there are more list items in the collection than displayed or not"
}
},
"description": "The additional data of the list"
},
{
"type": "object",
"properties": {
"next_start": {
"type": "integer",
"description": "Next pagination start"
}
}
}
],
"description": "The pagination details of the list"
}
}
}
}
}
NotesGetCommentDetailsResponse
{
"type": "object",
"title": "oneCommentResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"format": "uuid",
"description": "The ID of the note"
},
"content": {
"type": "string",
"description": "The content of the note in HTML format. Subject to sanitization on the back-end."
},
"user_id": {
"type": "integer",
"description": "The ID of the user who created the comment"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the note"
},
"object_id": {
"type": "string",
"description": "The ID of the object that the comment is attached to, will be the id of the note"
},
"company_id": {
"type": "integer",
"description": "The ID of the company"
},
"updater_id": {
"type": "integer",
"description": "The ID of the user who last updated the comment"
},
"active_flag": {
"type": "boolean",
"description": "Whether the note is active or deleted"
},
"object_type": {
"type": "string",
"description": "The type of object that the comment is attached to, will be \"note\""
},
"update_time": {
"type": "string",
"description": "The creation date and time of the note"
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
NotesGetDetailsResponse
{
"type": "object",
"title": "oneNoteResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the note"
},
"deal": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the deal this note is attached to"
}
},
"description": "The deal this note is attached to"
},
"user": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the note creator"
},
"email": {
"type": "string",
"description": "The email of the note creator"
},
"is_you": {
"type": "boolean",
"description": "Whether the note is created by you or not"
},
"icon_url": {
"type": "string",
"description": "The URL of the note creator avatar picture"
}
},
"description": "The user who created the note"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization the note is attached to"
},
"person": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the person the note is attached to"
}
},
"description": "The person the note is attached to"
},
"content": {
"type": "string",
"description": "The content of the note in HTML format. Subject to sanitization on the back-end."
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal the note is attached to"
},
"lead_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the lead the note is attached to"
},
"user_id": {
"type": "integer",
"description": "The ID of the note creator"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the note"
},
"person_id": {
"type": "integer",
"description": "The ID of the person the note is attached to"
},
"active_flag": {
"type": "boolean",
"description": "Whether the note is active or deleted"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the note"
},
"organization": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the organization the note is attached to"
}
},
"description": "The organization the note is attached to"
},
"last_update_user_id": {
"type": "integer",
"description": "The ID of the user who last updated the note"
},
"pinned_to_deal_flag": {
"type": "boolean",
"description": "If true, the results are filtered by note to deal pinning state"
},
"pinned_to_person_flag": {
"type": "boolean",
"description": "If true, the results are filtered by note to person pinning state"
},
"pinned_to_organization_flag": {
"type": "boolean",
"description": "If true, the results are filtered by note to organization pinning state"
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
NotesUpdateCommentRequest
{
"type": "object",
"title": "CommentPostPutObject",
"required": [
"content"
],
"properties": {
"content": {
"type": "string",
"description": "The content of the comment in HTML format. Subject to sanitization on the back-end."
}
}
}
NotesUpdateCommentResponse
{
"type": "object",
"title": "oneCommentResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"format": "uuid",
"description": "The ID of the note"
},
"content": {
"type": "string",
"description": "The content of the note in HTML format. Subject to sanitization on the back-end."
},
"user_id": {
"type": "integer",
"description": "The ID of the user who created the comment"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the note"
},
"object_id": {
"type": "string",
"description": "The ID of the object that the comment is attached to, will be the id of the note"
},
"company_id": {
"type": "integer",
"description": "The ID of the company"
},
"updater_id": {
"type": "integer",
"description": "The ID of the user who last updated the comment"
},
"active_flag": {
"type": "boolean",
"description": "Whether the note is active or deleted"
},
"object_type": {
"type": "string",
"description": "The type of object that the comment is attached to, will be \"note\""
},
"update_time": {
"type": "string",
"description": "The creation date and time of the note"
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
NotesUpdateNoteRequest
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "The content of the note in HTML format. Subject to sanitization on the back-end."
}
}
},
{
"type": "object",
"properties": {
"org_id": {
"type": "integer",
"description": "The ID of the organization the note will be attached to"
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal the note will be attached to"
},
"lead_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the lead the note will be attached to"
},
"person_id": {
"type": "integer",
"description": "The ID of the person the note will be attached to"
}
}
},
{
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"description": "The ID of the user who will be marked as the author of the note. Only an admin can change the author."
},
"add_time": {
"type": "string",
"description": "The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS"
},
"pinned_to_deal_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "If set, the results are filtered by note to deal pinning state (`deal_id` is also required)"
},
"pinned_to_lead_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "If set, the results are filtered by note to lead pinning state (`lead_id` is also required)"
},
"pinned_to_person_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "If set, the results are filtered by note to person pinning state (`person_id` is also required)"
},
"pinned_to_organization_flag": {
"allOf": [
{
"enum": [
0,
1
],
"type": "number",
"title": "numberBoolean"
}
],
"description": "If set, the results are filtered by note to organization pinning state (`org_id` is also required)"
}
}
}
],
"title": "noteRequest"
}
NotesUpdateNoteResponse
{
"type": "object",
"title": "oneNoteResponse200",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the note"
},
"deal": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the deal this note is attached to"
}
},
"description": "The deal this note is attached to"
},
"user": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the note creator"
},
"email": {
"type": "string",
"description": "The email of the note creator"
},
"is_you": {
"type": "boolean",
"description": "Whether the note is created by you or not"
},
"icon_url": {
"type": "string",
"description": "The URL of the note creator avatar picture"
}
},
"description": "The user who created the note"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization the note is attached to"
},
"person": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the person the note is attached to"
}
},
"description": "The person the note is attached to"
},
"content": {
"type": "string",
"description": "The content of the note in HTML format. Subject to sanitization on the back-end."
},
"deal_id": {
"type": "integer",
"description": "The ID of the deal the note is attached to"
},
"lead_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the lead the note is attached to"
},
"user_id": {
"type": "integer",
"description": "The ID of the note creator"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the note"
},
"person_id": {
"type": "integer",
"description": "The ID of the person the note is attached to"
},
"active_flag": {
"type": "boolean",
"description": "Whether the note is active or deleted"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the note"
},
"organization": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the organization the note is attached to"
}
},
"description": "The organization the note is attached to"
},
"last_update_user_id": {
"type": "integer",
"description": "The ID of the user who last updated the note"
},
"pinned_to_deal_flag": {
"type": "boolean",
"description": "If true, the results are filtered by note to deal pinning state"
},
"pinned_to_person_flag": {
"type": "boolean",
"description": "If true, the results are filtered by note to person pinning state"
},
"pinned_to_organization_flag": {
"type": "boolean",
"description": "If true, the results are filtered by note to organization pinning state"
}
}
},
"success": {
"type": "boolean",
"description": "If the request was successful or not"
}
}
}
OauthRefreshTokenRequest
{
"type": "object",
"title": "getTokensRequest",
"properties": {
"grant_type": {
"enum": [
"authorization_code",
"refresh_token"
],
"type": "string",
"default": "refresh_token",
"description": "Since you are to refresh your access_token, you must use the value \"refresh_token\""
},
"refresh_token": {
"type": "string",
"description": "The refresh token that you received after you exchanged the authorization code"
}
}
}
OauthRefreshTokenResponse
{
"type": "object",
"title": "getTokensResponse200",
"properties": {
"scope": {
"type": "string",
"description": "List of scopes to which users have agreed to grant access within this `access_token`"
},
"api_domain": {
"type": "string",
"description": "The base URL path, including the company_domain, where the requests can be sent to"
},
"expires_in": {
"type": "integer",
"description": "The maximum time in seconds until the `access_token` expires"
},
"token_type": {
"type": "string",
"description": "The format of the token. Always \"Bearer\"."
},
"access_token": {
"type": "string",
"description": "You need to use an `access_token` for accessing the user's data via API. You will need to [refresh the access token](https://pipedrive.readme.io/docs/marketplace-oauth-authorization#step-7-refreshing-the-tokens) if the `access_token` becomes invalid."
},
"refresh_token": {
"type": "string",
"description": "A refresh token is needed when you refresh the access token. refresh_token will expire if it isn't used in 60 days. Each time refresh_token is used, its expiry date is reset back to 60 days."
}
}
}
OrganizationFieldsAddNewFieldRequest
{
"allOf": [
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the field"
},
"options": {
"type": "array",
"items": {
"type": "object"
},
"description": "When `field_type` is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. Example: `[{\"label\":\"New Item\"}]`"
},
"add_visible_flag": {
"type": "boolean",
"default": true,
"description": "Whether the field is available in the 'add new' modal or not (both in the web and mobile app)"
}
}
},
{
"type": "object",
"required": [
"field_type"
],
"properties": {
"field_type": {
"enum": [
"address",
"date",
"daterange",
"double",
"enum",
"monetary",
"org",
"people",
"phone",
"set",
"text",
"time",
"timerange",
"user",
"varchar",
"varchar_auto",
"visible_to"
],
"type": "string",
"description": "The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`address`</td><td>Address field (has multiple subfields, autocompleted by Google Maps)</td></tr><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td></tr><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td></tr><tr><td>`double`</td><td>Numeric value</td></tr><tr><td>`enum`</td><td>Options field with a single possible chosen option</td></tr><tr></tr><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td></tr><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td></tr><tr><td>`people`</td><td>Person field (contains a person ID which is stored on the same account)</td></tr><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td></tr><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td></tr><tr><td>`text`</td><td>Long text (up to 65k characters)</td></tr><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td></tr><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td></tr><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td></tr><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td></tr><tr><td>`visible_to`</td><td>System field that keeps item's visibility setting</td></tr></table>"
}
}
}
],
"title": "createFieldRequest"
}