Pipedrive

Sales CRM and pipeline management

developers.pipedrive.com/docs/api ↗

Version

1.0.0

OpenAPI

3.0.1

Endpoints

278

Schemas

418

87

Quality

Updated

3 days ago

Crm crm sales pipeline

Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://api.pipedrive.com/v1

Endpoints

Clear filters

GET POST PUT PATCH DELETE

Activities 2 endpoints

DELETE /activities Delete multiple activities in bulk

Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.

operationId: Activities_deleteBulk

Parameters

Name	In	Required	Type	Description
ids	query	required	string	The comma-separated IDs of activities that will be deleted

Responses

200

The activities were successfully deleted

DELETE /activities

DELETE /activities/{id} Delete an activity

Marks an activity as deleted. After 30 days, the activity will be permanently deleted.

operationId: Activities_markAsDeleted

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the activity

Responses

200

The activity was successfully deleted

DELETE /activities/{id}

Activitytypes 2 endpoints

DELETE /activityTypes Delete multiple activity types in bulk

Marks multiple activity types as deleted.

operationId: ActivityTypes_markAsDeletedBulk

Parameters

Name	In	Required	Type	Description
ids	query	required	string	The comma-separated activity type IDs

Responses

200

The activity types were successfully deleted

DELETE /activityTypes

DELETE /activityTypes/{id} Delete an activity type

Marks an activity type as deleted.

operationId: ActivityTypes_markAsDeleted

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the activity type

Responses

200

The activity type was successfully deleted

DELETE /activityTypes/{id}

Calllogs 1 endpoints

DELETE /callLogs/{id} Delete a call log

Deletes a call log. If there is an audio recording attached to it, it will also be deleted. The related activity will not be removed by this request. If you want to remove the related activities, please use the endpoint which is specific for activities.

operationId: CallLogs_deleteLog

Parameters

Name	In	Required	Type	Description
id	path	required	string	The ID received when you create the call log

Responses

200

The call log was successfully deleted.

403

You don’t have permission to access the resource.

404

A resource required to process the request was not found.

410

The callLog you are trying to access is no longer available.

500

There was an error processing the request.

DELETE /callLogs/{id}

Channels 2 endpoints

DELETE /channels/{channel-id}/conversations/{conversation-id} Delete a conversation

Deletes an existing conversation. To use the endpoint, you need to have Messengers integration OAuth scope enabled and the Messaging manifest ready for the Messaging app extension.

operationId: Channels_deleteConversation

Parameters

Name	In	Required	Type	Description
channel-id	path	required	string	The ID of the channel provided by the integration
conversation-id	path	required	string	The ID of the conversation provided by the integration

Responses

200

The conversation was deleted

403

Forbidden

404

Not Found

DELETE /channels/{channel-id}/conversations/{conversation-id}

DELETE /channels/{id} Delete a channel

Deletes an existing messenger’s channel and all related entities (conversations and messages). To use the endpoint, you need to have Messengers integration OAuth scope enabled and the Messaging manifest ready for the Messaging app extension.

operationId: Channels_deleteChannelById

Parameters

Name	In	Required	Type	Description
id	path	required	string	The ID of the channel provided by the integration

Responses

200

The channel was deleted

400

Bad Request

DELETE /channels/{id}

Dealfields 2 endpoints

DELETE /dealFields Delete multiple deal fields in bulk

Marks multiple deal fields as deleted.

operationId: DealFields_deleteMultipleBulk

Parameters

Name	In	Required	Type	Description
ids	query	required	string	The comma-separated field IDs to delete

Responses

200

Success

DELETE /dealFields

DELETE /dealFields/{id} Delete a deal field

Marks a field as deleted. For more information, see the tutorial for deleting a custom field.

operationId: DealFields_markAsDeleted

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the field

Responses

200

Success

DELETE /dealFields/{id}

Deals 5 endpoints

DELETE /deals Delete multiple deals in bulk

Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.

operationId: Deals_deleteBulk

Parameters

Name	In	Required	Type	Description
ids	query	required	string	The comma-separated IDs that will be deleted

Responses

200

Delete multiple deals in bulk

DELETE /deals

DELETE /deals/{id} Delete a deal

Marks a deal as deleted. After 30 days, the deal will be permanently deleted.

operationId: Deals_markAsDeleted

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the deal

Responses

200

Delete a deal

DELETE /deals/{id}

DELETE /deals/{id}/followers/{follower_id} Delete a follower from a deal

Deletes a follower from a deal.

operationId: Deals_removeFollower

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the deal
follower_id	path	required	integer	The ID of the follower

Responses

200

Delete a follower from a deal

DELETE /deals/{id}/followers/{follower_id}

DELETE /deals/{id}/participants/{deal_participant_id} Delete a participant from a deal

Deletes a participant from a deal.

operationId: Deals_deleteParticipant

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the deal
deal_participant_id	path	required	integer	The ID of the participant of the deal

Responses

200

Delete a participant from a deal

DELETE /deals/{id}/participants/{deal_participant_id}

DELETE /deals/{id}/products/{product_attachment_id} Delete an attached product from a deal

Deletes a product attachment from a deal, using the product_attachment_id.

operationId: Deals_deleteAttachedProduct

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the deal
product_attachment_id	path	required	integer	The product attachment ID

Responses

200

Delete an attached product from a deal

DELETE /deals/{id}/products/{product_attachment_id}

Files 1 endpoints

DELETE /files/{id} Delete a file

Marks a file as deleted. After 30 days, the file will be permanently deleted.

operationId: Files_markAsDeleted

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the file

Responses

200

Delete a file from Pipedrive

DELETE /files/{id}

Filters 2 endpoints

DELETE /filters Delete multiple filters in bulk

Marks multiple filters as deleted.

operationId: Filters_deleteBulk

Parameters

Name	In	Required	Type	Description
ids	query	required	string	The comma-separated filter IDs to delete

Responses

200

Success

DELETE /filters

DELETE /filters/{id} Delete a filter

Marks a filter as deleted.

operationId: Filters_markAsDeleted

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the filter

Responses

200

Success

DELETE /filters/{id}

Goals 1 endpoints

DELETE /goals/{id} Delete existing goal

Marks a goal as deleted.

operationId: Goals_markAsDeleted

Parameters

Name	In	Required	Type	Description
id	path	required	string	The ID of the goal

Responses

200

Successful response with id ‘success’ field only

DELETE /goals/{id}

Leadlabels 1 endpoints

DELETE /leadLabels/{id} Delete a lead label

Deletes a specific lead label.

operationId: LeadLabels_deleteLabel

Parameters

Name	In	Required	Type	Description
id	path	required	string	The ID of the lead label

Responses

200

Successful response with id value only. Used in DELETE calls.

404

A resource describing an error

DELETE /leadLabels/{id}

Leads 1 endpoints

DELETE /leads/{id} Delete a lead

Deletes a specific lead.

operationId: Leads_deleteLead

Parameters

Name	In	Required	Type	Description
id	path	required	string	The ID of the lead

Responses

200

Successful response with id value only. Used in DELETE calls.

404

A resource describing an error

DELETE /leads/{id}

Mailbox 1 endpoints

DELETE /mailbox/mailThreads/{id} Delete mail thread

Marks a mail thread as deleted.

operationId: Mailbox_markThreadDeleted

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the mail thread

Responses

200

Marks mail thread as deleted

DELETE /mailbox/mailThreads/{id}

Meetings 1 endpoints

DELETE /meetings/userProviderLinks/{id} Delete the link between a user and the installed video call integration

A video calling provider must call this endpoint to remove the link between a user and the installed video calling app.

operationId: Meetings_removeUserProviderLink

Parameters

Name	In	Required	Type	Description
id	path	required	string	Unique identifier linking a user to the installed integration

Responses

200

User provider link successfully removed

401

No permission to remove user provider link

403

Incorrect parameter provided

DELETE /meetings/userProviderLinks/{id}

Notes 2 endpoints

DELETE /notes/{id} Delete a note

Deletes a specific note.

operationId: Notes_deleteNote

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the note

Responses

200

Delete a note

DELETE /notes/{id}

DELETE /notes/{id}/comments/{commentId} Delete a comment related to a note

Deletes a comment.

operationId: Notes_deleteComment

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the note
commentId	path	required	string	The ID of the comment

Responses

200

Delete a comment

DELETE /notes/{id}/comments/{commentId}

Organizationfields 2 endpoints

DELETE /organizationFields Delete multiple organization fields in bulk

Marks multiple fields as deleted.

operationId: OrganizationFields_deleteMultipleBulk

Parameters

Name	In	Required	Type	Description
ids	query	required	string	The comma-separated field IDs to delete

Responses

200

Success

DELETE /organizationFields

DELETE /organizationFields/{id} Delete an organization field

Marks a field as deleted. For more information, see the tutorial for deleting a custom field.

operationId: OrganizationFields_markAsDeleted

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the field

Responses

200

Success

DELETE /organizationFields/{id}

Organizationrelationships 1 endpoints

DELETE /organizationRelationships/{id} Delete an organization relationship

Deletes an organization relationship and returns the deleted ID.

operationId: OrganizationRelationships_deleteById

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the organization relationship

Responses

200

Success

DELETE /organizationRelationships/{id}

Organizations 3 endpoints

DELETE /organizations Delete multiple organizations in bulk

Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.

operationId: Organizations_deleteMultipleBulk

Parameters

Name	In	Required	Type	Description
ids	query	required	string	The comma-separated IDs that will be deleted

Responses

200

Success

DELETE /organizations

DELETE /organizations/{id} Delete an organization

Marks an organization as deleted. After 30 days, the organization will be permanently deleted.

operationId: Organizations_deleteMarkedOrganization

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the organization

Responses

200

Success

DELETE /organizations/{id}

DELETE /organizations/{id}/followers/{follower_id} Delete a follower from an organization

Deletes a follower from an organization. You can retrieve the follower_id from the List followers of an organization endpoint.

operationId: Organizations_deleteFollower

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the organization
follower_id	path	required	integer	The ID of the follower

Responses

200

Success

DELETE /organizations/{id}/followers/{follower_id}

Personfields 2 endpoints

DELETE /personFields Delete multiple person fields in bulk

Marks multiple fields as deleted.

operationId: PersonFields_deleteMultipleBulk

Parameters

Name	In	Required	Type	Description
ids	query	required	string	The comma-separated field IDs to delete

Responses

200

Success

DELETE /personFields

DELETE /personFields/{id} Delete a person field

Marks a field as deleted. For more information, see the tutorial for deleting a custom field.

operationId: PersonFields_markAsDeleted

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the field

Responses

200

Success

DELETE /personFields/{id}

Persons 4 endpoints

DELETE /persons Delete multiple persons in bulk

Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.

operationId: Persons_deleteMultipleBulk

Parameters

Name	In	Required	Type	Description
ids	query	required	string	The comma-separated IDs that will be deleted

Responses

200

Success

DELETE /persons

DELETE /persons/{id} Delete a person

Marks a person as deleted. After 30 days, the person will be permanently deleted.

operationId: Persons_markAsDeleted

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the person

Responses

200

Success

DELETE /persons/{id}

DELETE /persons/{id}/followers/{follower_id} Delete a follower from a person

Deletes a follower from a person.

operationId: Persons_deleteFollower

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the person
follower_id	path	required	integer	The ID of the follower

Responses

200

Success

DELETE /persons/{id}/followers/{follower_id}

DELETE /persons/{id}/picture Delete person picture

Deletes a person’s picture.

operationId: Persons_deletePicture

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the person

Responses

200

Success

DELETE /persons/{id}/picture

Pipelines 1 endpoints

DELETE /pipelines/{id} Delete a pipeline

Marks a pipeline as deleted.

operationId: Pipelines_deletePipeline

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the pipeline

Responses

200

Delete pipeline

DELETE /pipelines/{id}

Productfields 2 endpoints

DELETE /productFields Delete multiple product fields in bulk

Marks multiple fields as deleted.

operationId: ProductFields_deleteMultipleBulk

Parameters

Name	In	Required	Type	Description
ids	query	required	string	The comma-separated field IDs to delete

Responses

200

Mark multiple product fields as deleted

DELETE /productFields

DELETE /productFields/{id} Delete a product field

Marks a product field as deleted. For more information, see the tutorial for deleting a custom field.

operationId: ProductFields_markAsDeleted

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the product field

Responses

200

Delete a product field

410

The product field with the specified ID does not exist or is inaccessible

DELETE /productFields/{id}

Products 2 endpoints

DELETE /products/{id} Delete a product

Marks a product as deleted. After 30 days, the product will be permanently deleted.

operationId: Products_markAsDeleted

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the product

Responses

200

Deletes a product

DELETE /products/{id}

DELETE /products/{id}/followers/{follower_id} Delete a follower from a product

Deletes a follower from a product.

operationId: Products_deleteFollower

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the product
follower_id	path	required	integer	The ID of the relationship between the follower and the product

Responses

200

Deletes a follower from a product

DELETE /products/{id}/followers/{follower_id}

Projects 1 endpoints

DELETE /projects/{id} Delete a project

Marks a project as deleted.

operationId: Projects_markAsDeleted

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the project

Responses

200

Delete a project.

DELETE /projects/{id}

Roles 2 endpoints

DELETE /roles/{id} Delete a role

Marks a role as deleted.

operationId: Roles_markAsDeleted

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the role

Responses

200

Delete a role

DELETE /roles/{id}

DELETE /roles/{id}/assignments Delete a role assignment

Removes the assigned user from a role and adds to the default role.

operationId: Roles_removeAssignment

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the role

Request Body

application/json

schema RolesRemoveAssignmentRequest

Property	Type	Required
user_id	integer	required

Responses

200

Delete assignment from a role

DELETE /roles/{id}/assignments

Stages 2 endpoints

DELETE /stages Delete multiple stages in bulk

Marks multiple stages as deleted.

operationId: Stages_deleteBulk

Parameters

Name	In	Required	Type	Description
ids	query	required	string	The comma-separated stage IDs to delete

Responses

200

Delete multiple stages

DELETE /stages

DELETE /stages/{id} Delete a stage

Marks a stage as deleted.

operationId: Stages_deleteStage

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the stage

Responses

200

Delete stage

DELETE /stages/{id}

Subscriptions 1 endpoints

DELETE /subscriptions/{id} Delete a subscription

Marks an installment or a recurring subscription as deleted.

operationId: Subscriptions_deleteMarked

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the subscription

Responses

200

Success

DELETE /subscriptions/{id}

Tasks 1 endpoints

DELETE /tasks/{id} Delete a task

Marks a task as deleted. If the task has subtasks then those will also be deleted.

operationId: Tasks_deleteTask

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the task

Responses

200

Deleted task.

DELETE /tasks/{id}

Webhooks 1 endpoints

DELETE /webhooks/{id} Delete existing Webhook

Deletes the specified Webhook.

operationId: Webhooks_deleteExistingWebhook

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the Webhook to delete

Responses

200

The webhook deletion success response

401

Unauthorized response

403

The webhook deletion forbidden response

404

The webhook deletion not found response

DELETE /webhooks/{id}

Load more endpoints

Schemas

object ActivitiesAddNewActivityRequest

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "org_id": {
          "type": "integer",
          "description": "The ID of the organization this activity is associated with"
        },
        "deal_id": {
          "type": "integer",
          "description": "The ID of the deal this activity is associated with"
        },
        "lead_id": {
          "type": "string",
          "format": "uuid",
          "nullable": true,
          "description": "The ID of the lead in the UUID format this activity is associated with"
        },
        "due_date": {
          "type": "string",
          "format": "date",
          "description": "The due date of the activity. Format: YYYY-MM-DD"
        },
        "due_time": {
          "type": "string",
          "description": "The due time of the activity in UTC. Format: HH:MM"
        },
        "duration": {
          "type": "string",
          "description": "The duration of the activity. Format: HH:MM"
        },
        "location": {
          "type": "string",
          "description": "The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps."
        },
        "person_id": {
          "type": "integer",
          "description": "The ID of the person this activity is associated with"
        },
        "project_id": {
          "type": "integer",
          "nullable": true,
          "description": "The ID of the project this activity is associated with"
        },
        "public_description": {
          "type": "string",
          "description": "Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity."
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "done": {
          "allOf": [
            {
              "enum": [
                0,
                1
              ],
              "type": "number",
              "title": "numberBoolean"
            }
          ],
          "description": "Whether the activity is done or not. 0 = Not done, 1 = Done"
        },
        "note": {
          "type": "string",
          "description": "The note of the activity (HTML format)"
        },
        "type": {
          "type": "string",
          "description": "The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes. When value for type is not set, it will be given a default value `Call`."
        },
        "subject": {
          "type": "string",
          "description": "The subject of the activity. When value for subject is not set, it will be given a default value `Call`."
        },
        "user_id": {
          "type": "integer",
          "description": "The ID of the user whom the activity is assigned to. If omitted, the activity is assigned to the authorized user."
        },
        "attendees": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The attendees of the activity. This can be either your existing Pipedrive contacts or an external email address. It requires a structure as follows: `[{\"email_address\":\"mail@example.org\"}]` or `[{\"person_id\":1, \"email_address\":\"mail@example.org\"}]`"
        },
        "busy_flag": {
          "type": "boolean",
          "description": "Set the activity as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset by never setting it or overriding it with `null`. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time."
        },
        "participants": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "List of multiple persons (participants) this activity is associated with. If omitted, single participant from `person_id` field is used. It requires a structure as follows: `[{\"person_id\":1,\"primary_flag\":true}]`"
        }
      }
    }
  ],
  "title": "addActivityRequest"
}

object ActivitiesAddNewActivityResponse

{
  "type": "object",
  "title": "addActivityResponse200",
  "properties": {
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "org_id": {
              "type": "integer",
              "description": "The ID of the organization this activity is associated with"
            },
            "deal_id": {
              "type": "integer",
              "description": "The ID of the deal this activity is associated with"
            },
            "lead_id": {
              "type": "string",
              "format": "uuid",
              "nullable": true,
              "description": "The ID of the lead in the UUID format this activity is associated with"
            },
            "due_date": {
              "type": "string",
              "format": "date",
              "description": "The due date of the activity. Format: YYYY-MM-DD"
            },
            "due_time": {
              "type": "string",
              "description": "The due time of the activity in UTC. Format: HH:MM"
            },
            "duration": {
              "type": "string",
              "description": "The duration of the activity. Format: HH:MM"
            },
            "location": {
              "type": "string",
              "description": "The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps."
            },
            "person_id": {
              "type": "integer",
              "description": "The ID of the person this activity is associated with"
            },
            "project_id": {
              "type": "integer",
              "nullable": true,
              "description": "The ID of the project this activity is associated with"
            },
            "public_description": {
              "type": "string",
              "description": "Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity."
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer",
              "description": "The ID of the activity, generated when the activity was created"
            },
            "done": {
              "type": "boolean",
              "description": "Whether the activity is done or not"
            },
            "file": {
              "type": "object",
              "description": "The file that is attached to this activity. For example, this can be a reference to an audio note file generated with Pipedrive mobile app."
            },
            "note": {
              "type": "string",
              "description": "The note of the activity (HTML format)"
            },
            "type": {
              "type": "string",
              "description": "The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes."
            },
            "series": {
              "type": "array",
              "items": {
                "type": "object"
              },
              "description": "The list of recurring activity instances. It is in a structure as follows: `[{due_date: \"2020-06-24\", due_time: \"10:00:00\"}]`"
            },
            "subject": {
              "type": "string",
              "description": "The subject of the activity"
            },
            "user_id": {
              "type": "integer",
              "description": "The ID of the user whom the activity is assigned to"
            },
            "add_time": {
              "type": "string",
              "description": "The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS."
            },
            "org_name": {
              "type": "string",
              "description": "The name of the organization this activity is associated with"
            },
            "rec_rule": {
              "type": "string",
              "description": "The rule for the recurrence of the activity. Is important for activities synced into Pipedrive from an external calendar. Example: \"RRULE:FREQ=WEEKLY;BYDAY=WE\""
            },
            "attendees": {
              "type": "array",
              "items": {
                "type": "object"
              },
              "nullable": true,
              "description": "The attendees of the activity. This can be either your existing Pipedrive contacts or an external email address."
            },
            "busy_flag": {
              "type": "boolean",
              "description": "Marks if the activity is set as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time."
            },
            "company_id": {
              "type": "integer",
              "description": "The user's company ID"
            },
            "deal_title": {
              "type": "string",
              "description": "The name of the deal this activity is associated with"
            },
            "owner_name": {
              "type": "string",
              "description": "The name of the user this activity is owned by"
            },
            "active_flag": {
              "type": "boolean",
              "description": "Whether the activity is active or not"
            },
            "person_name": {
              "type": "string",
              "description": "The name of the person this activity is associated with"
            },
            "update_time": {
              "type": "string",
              "description": "The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS."
            },
            "participants": {
              "type": "array",
              "items": {
                "type": "object"
              },
              "nullable": true,
              "description": "List of multiple persons (participants) this activity is associated with"
            },
            "reference_id": {
              "type": "integer",
              "description": "Together with the `reference_type`, gives the ID of the other object"
            },
            "gcal_event_id": {
              "type": "string",
              "description": "For the activity which syncs to Google calendar, this is the Google event ID. NB! This field is related to old Google calendar sync and will be deprecated soon."
            },
            "location_route": {
              "type": "string",
              "description": "A subfield of the location field. Indicates street name."
            },
            "reference_type": {
              "type": "string",
              "description": "If the activity references some other object, it is indicated here. For example, value `Salesphone` refers to activities created with Caller."
            },
            "update_user_id": {
              "type": "integer",
              "description": "The ID of the user who was the last to update this activity"
            },
            "source_timezone": {
              "type": "string",
              "description": "The timezone the activity was created in an external calendar"
            },
            "deal_dropbox_bcc": {
              "type": "string",
              "description": "The BCC email address of the deal"
            },
            "location_country": {
              "type": "string",
              "description": "A subfield of the location field. Indicates country."
            },
            "location_locality": {
              "type": "string",
              "description": "A subfield of the location field. Indicates city/town/village/locality."
            },
            "created_by_user_id": {
              "type": "integer",
              "description": "The ID of the user who created the activity"
            },
            "google_calendar_id": {
              "type": "string",
              "description": "The Google calendar ID that this activity syncs to. NB! This field is related to old Google calendar sync and will be deprecated soon."
            },
            "person_dropbox_bcc": {
              "type": "string",
              "description": "The BCC email address of the person"
            },
            "rec_rule_extension": {
              "type": "string",
              "description": "Additional rules for the recurrence of the activity, extend the `rec_rule`. Is important for activities synced into Pipedrive from an external calendar."
            },
            "assigned_to_user_id": {
              "type": "integer",
              "description": "The ID of the user to whom the activity is assigned to. Equal to `user_id`."
            },
            "location_subpremise": {
              "type": "string",
              "description": "A subfield of the location field. Indicates apartment/suite number."
            },
            "marked_as_done_time": {
              "type": "string",
              "description": "The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS."
            },
            "google_calendar_etag": {
              "type": "string",
              "description": "The Google calendar API etag (version) that is used for syncing this activity. NB! This field is related to old Google calendar sync and will be deprecated soon."
            },
            "location_postal_code": {
              "type": "string",
              "description": "A subfield of the location field. Indicates ZIP/postal code."
            },
            "location_sublocality": {
              "type": "string",
              "description": "A subfield of the location field. Indicates district/sublocality."
            },
            "conference_meeting_id": {
              "type": "string",
              "description": "The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity"
            },
            "conference_meeting_url": {
              "type": "string",
              "description": "The link to join the meeting which is associated with this activity"
            },
            "last_notification_time": {
              "type": "string",
              "description": "The date and time of latest notifications sent about this activity to the participants or the attendees of this activity"
            },
            "location_street_number": {
              "type": "string",
              "description": "A subfield of the location field. Indicates house number."
            },
            "rec_master_activity_id": {
              "type": "integer",
              "description": "The ID of parent activity for a recurrent activity if the current activity is an exception to recurrence rules"
            },
            "notification_language_id": {
              "type": "integer",
              "description": "The ID of the language the notifications are sent in"
            },
            "conference_meeting_client": {
              "type": "string",
              "description": "The ID of the Marketplace app, which is connected to this activity"
            },
            "last_notification_user_id": {
              "type": "integer",
              "description": "The ID of the user who triggered the sending of the latest notifications about this activity to the participants or the attendees of this activity"
            },
            "location_formatted_address": {
              "type": "string",
              "description": "A subfield of the location field. Indicates full/combined address."
            },
            "location_admin_area_level_1": {
              "type": "string",
              "description": "A subfield of the location field. Indicates state/county."
            },
            "location_admin_area_level_2": {
              "type": "string",
              "description": "A subfield of the location field. Indicates region."
            },
            "calendar_sync_include_context": {
              "type": "string",
              "description": "For activities that sync to an external calendar, this setting indicates if the activity syncs with context (what are the deals, persons, organizations this activity is related to)"
            }
          }
        }
      ],
      "title": "activityResponseObject"
    },
    "success": {
      "type": "boolean"
    },
    "additional_data": {
      "type": "object",
      "properties": {
        "updates_story_id": {
          "type": "integer",
          "description": "This field will be deprecated"
        }
      }
    },
    "related_objects": {
      "type": "object",
      "properties": {
        "deal": {
          "type": "object",
          "properties": {
            "DEAL_ID": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "The ID of the deal associated with the item"
                },
                "title": {
                  "type": "string",
                  "description": "The title of the deal associated with the item"
                },
                "value": {
                  "type": "number",
                  "description": "The value of the deal that is associated with the item"
                },
                "status": {
                  "type": "string",
                  "description": "The status of the deal associated with the item"
                },
                "currency": {
                  "type": "string",
                  "description": "The currency of the deal value"
                },
                "stage_id": {
                  "type": "integer",
                  "description": "The ID of the stage the deal is currently at"
                },
                "pipeline_id": {
                  "type": "integer",
                  "description": "The ID of the pipeline the deal is in"
                }
              },
              "description": "The ID of the deal which is associated with the item"
            }
          }
        },
        "user": {
          "type": "object",
          "properties": {
            "USER_ID": {
              "type": "object",
              "allOf": [
                {
                  "properties": {
                    "id": {
                      "type": "integer",
                      "description": "The ID of the user"
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the user"
                    },
                    "email": {
                      "type": "string",
                      "description": "The email of the user"
                    },
                    "has_pic": {
                      "type": "integer",
                      "description": "Whether the user has picture or not. 0 = No picture, 1 = Has picture."
                    },
                    "pic_hash": {
                      "type": "string",
                      "nullable": true,
                      "description": "The user picture hash"
                    },
                    "active_flag": {
                      "type": "boolean",
                      "description": "Whether the user is active or not"
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "The ID of the user"
                }
              ],
              "title": "userDataWithId"
            }
          }
        },
        "person": {
          "type": "object",
          "properties": {
            "PERSON_ID": {
              "type": "object",
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "active_flag": {
                      "type": "boolean",
                      "description": "Whether the associated person is active or not"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "description": "The ID of the person associated with the item"
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the person associated with the item"
                    },
                    "email": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "label": {
                            "type": "string",
                            "description": "The type of the email"
                          },
                          "value": {
                            "type": "string",
                            "description": "The email of the associated person"
                          },
                          "primary": {
                            "type": "boolean",
                            "description": "Whether this is the primary email or not"
                          }
                        }
                      },
                      "description": "The emails of the person associated with the item"
                    },
                    "phone": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "label": {
                            "type": "string",
                            "description": "The type of the phone number"
                          },
                          "value": {
                            "type": "string",
                            "description": "The phone number of the person associated with the item"
                          },
                          "primary": {
                            "type": "boolean",
                            "description": "Whether this is the primary phone number or not"
                          }
                        }
                      },
                      "description": "The phone numbers of the person associated with the item"
                    },
                    "owner_id": {
                      "type": "integer",
                      "description": "The ID of the owner of the person that is associated with the item"
                    }
                  }
                }
              ],
              "description": "The ID of the person associated with the item"
            }
          }
        },
        "organization": {
          "type": "object",
          "properties": {
            "ORGANIZATION_ID": {
              "type": "object",
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "active_flag": {
                      "type": "boolean",
                      "description": "Whether the associated organization is active or not"
                    }
                  }
                },
                {
                  "type": "object",
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "description": "The ID of the organization associated with the item"
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "description": "The name of the organization associated with the item"
                        },
                        "address": {
                          "type": "string",
                          "description": "The address of the organization"
                        },
                        "cc_email": {
                          "type": "string",
                          "description": "The BCC email of the organization associated with the item"
                        },
                        "owner_id": {
                          "type": "integer",
                          "description": "The ID of the owner of the organization that is associated with the item"
                        },
                        "people_count": {
                          "type": "integer",
                          "description": "The number of people connected with the organization that is associated with the item"
                        }
                      }
                    }
                  ],
                  "description": "The ID of the organization associated with the item"
                }
              ],
              "description": "The ID of the organization associated with the item"
            }
          }
        }
      }
    }
  }
}

object ActivitiesDeleteBulkResponse

{
  "type": "object",
  "title": "deleteActivitiesResponse200",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "An array of the IDs of activities that were deleted"
        }
      }
    },
    "success": {
      "type": "boolean"
    }
  }
}

object ActivitiesGetAllActivities403Response

{
  "type": "object",
  "title": "failResponse",
  "properties": {
    "error": {
      "type": "string",
      "description": "The error message"
    },
    "success": {
      "type": "boolean",
      "description": "If the response is successful or not"
    }
  }
}

object ActivitiesGetAllActivitiesResponse

{
  "type": "object",
  "title": "getActivitiesCollectionResponse200",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "org_id": {
                "type": "integer",
                "description": "The ID of the organization this activity is associated with"
              },
              "deal_id": {
                "type": "integer",
                "description": "The ID of the deal this activity is associated with"
              },
              "lead_id": {
                "type": "string",
                "format": "uuid",
                "nullable": true,
                "description": "The ID of the lead in the UUID format this activity is associated with"
              },
              "due_date": {
                "type": "string",
                "format": "date",
                "description": "The due date of the activity. Format: YYYY-MM-DD"
              },
              "due_time": {
                "type": "string",
                "description": "The due time of the activity in UTC. Format: HH:MM"
              },
              "duration": {
                "type": "string",
                "description": "The duration of the activity. Format: HH:MM"
              },
              "location": {
                "type": "string",
                "description": "The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps."
              },
              "person_id": {
                "type": "integer",
                "description": "The ID of the person this activity is associated with"
              },
              "project_id": {
                "type": "integer",
                "nullable": true,
                "description": "The ID of the project this activity is associated with"
              },
              "public_description": {
                "type": "string",
                "description": "Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity."
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "description": "The ID of the activity, generated when the activity was created"
              },
              "done": {
                "type": "boolean",
                "description": "Whether the activity is done or not"
              },
              "type": {
                "type": "string",
                "description": "The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes."
              },
              "subject": {
                "type": "string",
                "description": "The subject of the activity"
              },
              "user_id": {
                "type": "integer",
                "description": "The ID of the user whom the activity is assigned to"
              },
              "add_time": {
                "type": "string",
                "description": "The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS."
              },
              "busy_flag": {
                "type": "boolean",
                "description": "Marks if the activity is set as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time."
              },
              "company_id": {
                "type": "integer",
                "description": "The user's company ID"
              },
              "active_flag": {
                "type": "boolean",
                "description": "Whether the activity is active or not"
              },
              "update_time": {
                "type": "string",
                "description": "The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS."
              },
              "location_route": {
                "type": "string",
                "description": "A subfield of the location field. Indicates street name."
              },
              "update_user_id": {
                "type": "integer",
                "description": "The ID of the user who was the last to update this activity"
              },
              "source_timezone": {
                "type": "string",
                "description": "The timezone the activity was created in an external calendar"
              },
              "location_country": {
                "type": "string",
                "description": "A subfield of the location field. Indicates country."
              },
              "location_locality": {
                "type": "string",
                "description": "A subfield of the location field. Indicates city/town/village/locality."
              },
              "location_subpremise": {
                "type": "string",
                "description": "A subfield of the location field. Indicates apartment/suite number."
              },
              "marked_as_done_time": {
                "type": "string",
                "description": "The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS."
              },
              "location_postal_code": {
                "type": "string",
                "description": "A subfield of the location field. Indicates ZIP/postal code."
              },
              "location_sublocality": {
                "type": "string",
                "description": "A subfield of the location field. Indicates district/sublocality."
              },
              "conference_meeting_id": {
                "type": "string",
                "description": "The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity"
              },
              "conference_meeting_url": {
                "type": "string",
                "description": "The link to join the meeting which is associated with this activity"
              },
              "location_street_number": {
                "type": "string",
                "description": "A subfield of the location field. Indicates house number."
              },
              "conference_meeting_client": {
                "type": "string",
                "description": "The ID of the Marketplace app, which is connected to this activity"
              },
              "location_formatted_address": {
                "type": "string",
                "description": "A subfield of the location field. Indicates full/combined address."
              },
              "location_admin_area_level_1": {
                "type": "string",
                "description": "A subfield of the location field. Indicates state/county."
              },
              "location_admin_area_level_2": {
                "type": "string",
                "description": "A subfield of the location field. Indicates region."
              }
            }
          }
        ],
        "title": "activityCollectionResponseObject"
      }
    },
    "success": {
      "type": "boolean"
    },
    "additional_data": {
      "type": "object",
      "properties": {
        "next_cursor": {
          "type": "string",
          "description": "The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned."
        }
      },
      "description": "The additional data of the list"
    }
  }
}

object ActivitiesGetDetailsResponse

{
  "type": "object",
  "title": "getActivityResponse200",
  "properties": {
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "org_id": {
              "type": "integer",
              "description": "The ID of the organization this activity is associated with"
            },
            "deal_id": {
              "type": "integer",
              "description": "The ID of the deal this activity is associated with"
            },
            "lead_id": {
              "type": "string",
              "format": "uuid",
              "nullable": true,
              "description": "The ID of the lead in the UUID format this activity is associated with"
            },
            "due_date": {
              "type": "string",
              "format": "date",
              "description": "The due date of the activity. Format: YYYY-MM-DD"
            },
            "due_time": {
              "type": "string",
              "description": "The due time of the activity in UTC. Format: HH:MM"
            },
            "duration": {
              "type": "string",
              "description": "The duration of the activity. Format: HH:MM"
            },
            "location": {
              "type": "string",
              "description": "The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps."
            },
            "person_id": {
              "type": "integer",
              "description": "The ID of the person this activity is associated with"
            },
            "project_id": {
              "type": "integer",
              "nullable": true,
              "description": "The ID of the project this activity is associated with"
            },
            "public_description": {
              "type": "string",
              "description": "Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity."
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer",
              "description": "The ID of the activity, generated when the activity was created"
            },
            "done": {
              "type": "boolean",
              "description": "Whether the activity is done or not"
            },
            "file": {
              "type": "object",
              "description": "The file that is attached to this activity. For example, this can be a reference to an audio note file generated with Pipedrive mobile app."
            },
            "note": {
              "type": "string",
              "description": "The note of the activity (HTML format)"
            },
            "type": {
              "type": "string",
              "description": "The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes."
            },
            "series": {
              "type": "array",
              "items": {
                "type": "object"
              },
              "description": "The list of recurring activity instances. It is in a structure as follows: `[{due_date: \"2020-06-24\", due_time: \"10:00:00\"}]`"
            },
            "subject": {
              "type": "string",
              "description": "The subject of the activity"
            },
            "user_id": {
              "type": "integer",
              "description": "The ID of the user whom the activity is assigned to"
            },
            "add_time": {
              "type": "string",
              "description": "The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS."
            },
            "org_name": {
              "type": "string",
              "description": "The name of the organization this activity is associated with"
            },
            "rec_rule": {
              "type": "string",
              "description": "The rule for the recurrence of the activity. Is important for activities synced into Pipedrive from an external calendar. Example: \"RRULE:FREQ=WEEKLY;BYDAY=WE\""
            },
            "attendees": {
              "type": "array",
              "items": {
                "type": "object"
              },
              "nullable": true,
              "description": "The attendees of the activity. This can be either your existing Pipedrive contacts or an external email address."
            },
            "busy_flag": {
              "type": "boolean",
              "description": "Marks if the activity is set as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time."
            },
            "company_id": {
              "type": "integer",
              "description": "The user's company ID"
            },
            "deal_title": {
              "type": "string",
              "description": "The name of the deal this activity is associated with"
            },
            "owner_name": {
              "type": "string",
              "description": "The name of the user this activity is owned by"
            },
            "active_flag": {
              "type": "boolean",
              "description": "Whether the activity is active or not"
            },
            "person_name": {
              "type": "string",
              "description": "The name of the person this activity is associated with"
            },
            "update_time": {
              "type": "string",
              "description": "The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS."
            },
            "participants": {
              "type": "array",
              "items": {
                "type": "object"
              },
              "nullable": true,
              "description": "List of multiple persons (participants) this activity is associated with"
            },
            "reference_id": {
              "type": "integer",
              "description": "Together with the `reference_type`, gives the ID of the other object"
            },
            "gcal_event_id": {
              "type": "string",
              "description": "For the activity which syncs to Google calendar, this is the Google event ID. NB! This field is related to old Google calendar sync and will be deprecated soon."
            },
            "location_route": {
              "type": "string",
              "description": "A subfield of the location field. Indicates street name."
            },
            "reference_type": {
              "type": "string",
              "description": "If the activity references some other object, it is indicated here. For example, value `Salesphone` refers to activities created with Caller."
            },
            "update_user_id": {
              "type": "integer",
              "description": "The ID of the user who was the last to update this activity"
            },
            "source_timezone": {
              "type": "string",
              "description": "The timezone the activity was created in an external calendar"
            },
            "deal_dropbox_bcc": {
              "type": "string",
              "description": "The BCC email address of the deal"
            },
            "location_country": {
              "type": "string",
              "description": "A subfield of the location field. Indicates country."
            },
            "location_locality": {
              "type": "string",
              "description": "A subfield of the location field. Indicates city/town/village/locality."
            },
            "created_by_user_id": {
              "type": "integer",
              "description": "The ID of the user who created the activity"
            },
            "google_calendar_id": {
              "type": "string",
              "description": "The Google calendar ID that this activity syncs to. NB! This field is related to old Google calendar sync and will be deprecated soon."
            },
            "person_dropbox_bcc": {
              "type": "string",
              "description": "The BCC email address of the person"
            },
            "rec_rule_extension": {
              "type": "string",
              "description": "Additional rules for the recurrence of the activity, extend the `rec_rule`. Is important for activities synced into Pipedrive from an external calendar."
            },
            "assigned_to_user_id": {
              "type": "integer",
              "description": "The ID of the user to whom the activity is assigned to. Equal to `user_id`."
            },
            "location_subpremise": {
              "type": "string",
              "description": "A subfield of the location field. Indicates apartment/suite number."
            },
            "marked_as_done_time": {
              "type": "string",
              "description": "The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS."
            },
            "google_calendar_etag": {
              "type": "string",
              "description": "The Google calendar API etag (version) that is used for syncing this activity. NB! This field is related to old Google calendar sync and will be deprecated soon."
            },
            "location_postal_code": {
              "type": "string",
              "description": "A subfield of the location field. Indicates ZIP/postal code."
            },
            "location_sublocality": {
              "type": "string",
              "description": "A subfield of the location field. Indicates district/sublocality."
            },
            "conference_meeting_id": {
              "type": "string",
              "description": "The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity"
            },
            "conference_meeting_url": {
              "type": "string",
              "description": "The link to join the meeting which is associated with this activity"
            },
            "last_notification_time": {
              "type": "string",
              "description": "The date and time of latest notifications sent about this activity to the participants or the attendees of this activity"
            },
            "location_street_number": {
              "type": "string",
              "description": "A subfield of the location field. Indicates house number."
            },
            "rec_master_activity_id": {
              "type": "integer",
              "description": "The ID of parent activity for a recurrent activity if the current activity is an exception to recurrence rules"
            },
            "notification_language_id": {
              "type": "integer",
              "description": "The ID of the language the notifications are sent in"
            },
            "conference_meeting_client": {
              "type": "string",
              "description": "The ID of the Marketplace app, which is connected to this activity"
            },
            "last_notification_user_id": {
              "type": "integer",
              "description": "The ID of the user who triggered the sending of the latest notifications about this activity to the participants or the attendees of this activity"
            },
            "location_formatted_address": {
              "type": "string",
              "description": "A subfield of the location field. Indicates full/combined address."
            },
            "location_admin_area_level_1": {
              "type": "string",
              "description": "A subfield of the location field. Indicates state/county."
            },
            "location_admin_area_level_2": {
              "type": "string",
              "description": "A subfield of the location field. Indicates region."
            },
            "calendar_sync_include_context": {
              "type": "string",
              "description": "For activities that sync to an external calendar, this setting indicates if the activity syncs with context (what are the deals, persons, organizations this activity is related to)"
            }
          }
        }
      ],
      "title": "activityResponseObject"
    },
    "success": {
      "type": "boolean"
    },
    "related_objects": {
      "type": "object",
      "properties": {
        "deal": {
          "type": "object",
          "properties": {
            "DEAL_ID": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "The ID of the deal associated with the item"
                },
                "title": {
                  "type": "string",
                  "description": "The title of the deal associated with the item"
                },
                "value": {
                  "type": "number",
                  "description": "The value of the deal that is associated with the item"
                },
                "status": {
                  "type": "string",
                  "description": "The status of the deal associated with the item"
                },
                "currency": {
                  "type": "string",
                  "description": "The currency of the deal value"
                },
                "stage_id": {
                  "type": "integer",
                  "description": "The ID of the stage the deal is currently at"
                },
                "pipeline_id": {
                  "type": "integer",
                  "description": "The ID of the pipeline the deal is in"
                }
              },
              "description": "The ID of the deal which is associated with the item"
            }
          }
        },
        "user": {
          "type": "object",
          "properties": {
            "USER_ID": {
              "type": "object",
              "allOf": [
                {
                  "properties": {
                    "id": {
                      "type": "integer",
                      "description": "The ID of the user"
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the user"
                    },
                    "email": {
                      "type": "string",
                      "description": "The email of the user"
                    },
                    "has_pic": {
                      "type": "integer",
                      "description": "Whether the user has picture or not. 0 = No picture, 1 = Has picture."
                    },
                    "pic_hash": {
                      "type": "string",
                      "nullable": true,
                      "description": "The user picture hash"
                    },
                    "active_flag": {
                      "type": "boolean",
                      "description": "Whether the user is active or not"
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "The ID of the user"
                }
              ],
              "title": "userDataWithId"
            }
          }
        },
        "person": {
          "type": "object",
          "properties": {
            "PERSON_ID": {
              "type": "object",
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "description": "The ID of the person associated with the item"
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the person associated with the item"
                    },
                    "email": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "label": {
                            "type": "string",
                            "description": "The type of the email"
                          },
                          "value": {
                            "type": "string",
                            "description": "The email of the associated person"
                          },
                          "primary": {
                            "type": "boolean",
                            "description": "Whether this is the primary email or not"
                          }
                        }
                      },
                      "description": "The emails of the person associated with the item"
                    },
                    "phone": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "label": {
                            "type": "string",
                            "description": "The type of the phone number"
                          },
                          "value": {
                            "type": "string",
                            "description": "The phone number of the person associated with the item"
                          },
                          "primary": {
                            "type": "boolean",
                            "description": "Whether this is the primary phone number or not"
                          }
                        }
                      },
                      "description": "The phone numbers of the person associated with the item"
                    },
                    "owner_id": {
                      "type": "integer",
                      "description": "The ID of the owner of the person that is associated with the item"
                    }
                  }
                }
              ],
              "description": "The ID of the person associated with the item"
            }
          }
        },
        "organization": {
          "type": "object",
          "properties": {
            "ORGANIZATION_ID": {
              "type": "object",
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "description": "The ID of the organization associated with the item"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "The name of the organization associated with the item"
                    },
                    "address": {
                      "type": "string",
                      "description": "The address of the organization"
                    },
                    "cc_email": {
                      "type": "string",
                      "description": "The BCC email of the organization associated with the item"
                    },
                    "owner_id": {
                      "type": "integer",
                      "description": "The ID of the owner of the organization that is associated with the item"
                    },
                    "people_count": {
                      "type": "integer",
                      "description": "The number of people connected with the organization that is associated with the item"
                    }
                  }
                }
              ],
              "description": "The ID of the organization associated with the item"
            }
          }
        }
      }
    }
  }
}

object ActivitiesListUserActivitiesResponse

{
  "type": "object",
  "title": "getActivitiesResponse200",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "org_id": {
                "type": "integer",
                "description": "The ID of the organization this activity is associated with"
              },
              "deal_id": {
                "type": "integer",
                "description": "The ID of the deal this activity is associated with"
              },
              "lead_id": {
                "type": "string",
                "format": "uuid",
                "nullable": true,
                "description": "The ID of the lead in the UUID format this activity is associated with"
              },
              "due_date": {
                "type": "string",
                "format": "date",
                "description": "The due date of the activity. Format: YYYY-MM-DD"
              },
              "due_time": {
                "type": "string",
                "description": "The due time of the activity in UTC. Format: HH:MM"
              },
              "duration": {
                "type": "string",
                "description": "The duration of the activity. Format: HH:MM"
              },
              "location": {
                "type": "string",
                "description": "The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps."
              },
              "person_id": {
                "type": "integer",
                "description": "The ID of the person this activity is associated with"
              },
              "project_id": {
                "type": "integer",
                "nullable": true,
                "description": "The ID of the project this activity is associated with"
              },
              "public_description": {
                "type": "string",
                "description": "Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity."
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "description": "The ID of the activity, generated when the activity was created"
              },
              "done": {
                "type": "boolean",
                "description": "Whether the activity is done or not"
              },
              "file": {
                "type": "object",
                "description": "The file that is attached to this activity. For example, this can be a reference to an audio note file generated with Pipedrive mobile app."
              },
              "note": {
                "type": "string",
                "description": "The note of the activity (HTML format)"
              },
              "type": {
                "type": "string",
                "description": "The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes."
              },
              "series": {
                "type": "array",
                "items": {
                  "type": "object"
                },
                "description": "The list of recurring activity instances. It is in a structure as follows: `[{due_date: \"2020-06-24\", due_time: \"10:00:00\"}]`"
              },
              "subject": {
                "type": "string",
                "description": "The subject of the activity"
              },
              "user_id": {
                "type": "integer",
                "description": "The ID of the user whom the activity is assigned to"
              },
              "add_time": {
                "type": "string",
                "description": "The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS."
              },
              "org_name": {
                "type": "string",
                "description": "The name of the organization this activity is associated with"
              },
              "rec_rule": {
                "type": "string",
                "description": "The rule for the recurrence of the activity. Is important for activities synced into Pipedrive from an external calendar. Example: \"RRULE:FREQ=WEEKLY;BYDAY=WE\""
              },
              "attendees": {
                "type": "array",
                "items": {
                  "type": "object"
                },
                "nullable": true,
                "description": "The attendees of the activity. This can be either your existing Pipedrive contacts or an external email address."
              },
              "busy_flag": {
                "type": "boolean",
                "description": "Marks if the activity is set as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time."
              },
              "company_id": {
                "type": "integer",
                "description": "The user's company ID"
              },
              "deal_title": {
                "type": "string",
                "description": "The name of the deal this activity is associated with"
              },
              "owner_name": {
                "type": "string",
                "description": "The name of the user this activity is owned by"
              },
              "active_flag": {
                "type": "boolean",
                "description": "Whether the activity is active or not"
              },
              "person_name": {
                "type": "string",
                "description": "The name of the person this activity is associated with"
              },
              "update_time": {
                "type": "string",
                "description": "The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS."
              },
              "participants": {
                "type": "array",
                "items": {
                  "type": "object"
                },
                "nullable": true,
                "description": "List of multiple persons (participants) this activity is associated with"
              },
              "reference_id": {
                "type": "integer",
                "description": "Together with the `reference_type`, gives the ID of the other object"
              },
              "gcal_event_id": {
                "type": "string",
                "description": "For the activity which syncs to Google calendar, this is the Google event ID. NB! This field is related to old Google calendar sync and will be deprecated soon."
              },
              "location_route": {
                "type": "string",
                "description": "A subfield of the location field. Indicates street name."
              },
              "reference_type": {
                "type": "string",
                "description": "If the activity references some other object, it is indicated here. For example, value `Salesphone` refers to activities created with Caller."
              },
              "update_user_id": {
                "type": "integer",
                "description": "The ID of the user who was the last to update this activity"
              },
              "source_timezone": {
                "type": "string",
                "description": "The timezone the activity was created in an external calendar"
              },
              "deal_dropbox_bcc": {
                "type": "string",
                "description": "The BCC email address of the deal"
              },
              "location_country": {
                "type": "string",
                "description": "A subfield of the location field. Indicates country."
              },
              "location_locality": {
                "type": "string",
                "description": "A subfield of the location field. Indicates city/town/village/locality."
              },
              "created_by_user_id": {
                "type": "integer",
                "description": "The ID of the user who created the activity"
              },
              "google_calendar_id": {
                "type": "string",
                "description": "The Google calendar ID that this activity syncs to. NB! This field is related to old Google calendar sync and will be deprecated soon."
              },
              "person_dropbox_bcc": {
                "type": "string",
                "description": "The BCC email address of the person"
              },
              "rec_rule_extension": {
                "type": "string",
                "description": "Additional rules for the recurrence of the activity, extend the `rec_rule`. Is important for activities synced into Pipedrive from an external calendar."
              },
              "assigned_to_user_id": {
                "type": "integer",
                "description": "The ID of the user to whom the activity is assigned to. Equal to `user_id`."
              },
              "location_subpremise": {
                "type": "string",
                "description": "A subfield of the location field. Indicates apartment/suite number."
              },
              "marked_as_done_time": {
                "type": "string",
                "description": "The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS."
              },
              "google_calendar_etag": {
                "type": "string",
                "description": "The Google calendar API etag (version) that is used for syncing this activity. NB! This field is related to old Google calendar sync and will be deprecated soon."
              },
              "location_postal_code": {
                "type": "string",
                "description": "A subfield of the location field. Indicates ZIP/postal code."
              },
              "location_sublocality": {
                "type": "string",
                "description": "A subfield of the location field. Indicates district/sublocality."
              },
              "conference_meeting_id": {
                "type": "string",
                "description": "The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity"
              },
              "conference_meeting_url": {
                "type": "string",
                "description": "The link to join the meeting which is associated with this activity"
              },
              "last_notification_time": {
                "type": "string",
                "description": "The date and time of latest notifications sent about this activity to the participants or the attendees of this activity"
              },
              "location_street_number": {
                "type": "string",
                "description": "A subfield of the location field. Indicates house number."
              },
              "rec_master_activity_id": {
                "type": "integer",
                "description": "The ID of parent activity for a recurrent activity if the current activity is an exception to recurrence rules"
              },
              "notification_language_id": {
                "type": "integer",
                "description": "The ID of the language the notifications are sent in"
              },
              "conference_meeting_client": {
                "type": "string",
                "description": "The ID of the Marketplace app, which is connected to this activity"
              },
              "last_notification_user_id": {
                "type": "integer",
                "description": "The ID of the user who triggered the sending of the latest notifications about this activity to the participants or the attendees of this activity"
              },
              "location_formatted_address": {
                "type": "string",
                "description": "A subfield of the location field. Indicates full/combined address."
              },
              "location_admin_area_level_1": {
                "type": "string",
                "description": "A subfield of the location field. Indicates state/county."
              },
              "location_admin_area_level_2": {
                "type": "string",
                "description": "A subfield of the location field. Indicates region."
              },
              "calendar_sync_include_context": {
                "type": "string",
                "description": "For activities that sync to an external calendar, this setting indicates if the activity syncs with context (what are the deals, persons, organizations this activity is related to)"
              }
            }
          }
        ],
        "title": "activityResponseObject"
      }
    },
    "success": {
      "type": "boolean"
    },
    "additional_data": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "limit": {
              "type": "integer",
              "description": "Items shown per page"
            },
            "start": {
              "type": "integer",
              "description": "Pagination start"
            },
            "next_start": {
              "type": "integer",
              "description": "Next pagination start"
            },
            "more_items_in_collection": {
              "type": "boolean",
              "description": "Whether there are more list items in the collection than displayed"
            }
          },
          "description": "Pagination details of the list"
        }
      }
    },
    "related_objects": {
      "type": "object",
      "properties": {
        "deal": {
          "type": "object",
          "properties": {
            "DEAL_ID": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "The ID of the deal associated with the item"
                },
                "title": {
                  "type": "string",
                  "description": "The title of the deal associated with the item"
                },
                "value": {
                  "type": "number",
                  "description": "The value of the deal that is associated with the item"
                },
                "status": {
                  "type": "string",
                  "description": "The status of the deal associated with the item"
                },
                "currency": {
                  "type": "string",
                  "description": "The currency of the deal value"
                },
                "stage_id": {
                  "type": "integer",
                  "description": "The ID of the stage the deal is currently at"
                },
                "pipeline_id": {
                  "type": "integer",
                  "description": "The ID of the pipeline the deal is in"
                }
              },
              "description": "The ID of the deal which is associated with the item"
            }
          }
        },
        "user": {
          "type": "object",
          "properties": {
            "USER_ID": {
              "type": "object",
              "allOf": [
                {
                  "properties": {
                    "id": {
                      "type": "integer",
                      "description": "The ID of the user"
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the user"
                    },
                    "email": {
                      "type": "string",
                      "description": "The email of the user"
                    },
                    "has_pic": {
                      "type": "integer",
                      "description": "Whether the user has picture or not. 0 = No picture, 1 = Has picture."
                    },
                    "pic_hash": {
                      "type": "string",
                      "nullable": true,
                      "description": "The user picture hash"
                    },
                    "active_flag": {
                      "type": "boolean",
                      "description": "Whether the user is active or not"
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "The ID of the user"
                }
              ],
              "title": "userDataWithId"
            }
          }
        },
        "person": {
          "type": "object",
          "properties": {
            "PERSON_ID": {
              "type": "object",
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "description": "The ID of the person associated with the item"
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the person associated with the item"
                    },
                    "email": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "label": {
                            "type": "string",
                            "description": "The type of the email"
                          },
                          "value": {
                            "type": "string",
                            "description": "The email of the associated person"
                          },
                          "primary": {
                            "type": "boolean",
                            "description": "Whether this is the primary email or not"
                          }
                        }
                      },
                      "description": "The emails of the person associated with the item"
                    },
                    "phone": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "label": {
                            "type": "string",
                            "description": "The type of the phone number"
                          },
                          "value": {
                            "type": "string",
                            "description": "The phone number of the person associated with the item"
                          },
                          "primary": {
                            "type": "boolean",
                            "description": "Whether this is the primary phone number or not"
                          }
                        }
                      },
                      "description": "The phone numbers of the person associated with the item"
                    },
                    "owner_id": {
                      "type": "integer",
                      "description": "The ID of the owner of the person that is associated with the item"
                    }
                  }
                }
              ],
              "description": "The ID of the person associated with the item"
            }
          }
        },
        "organization": {
          "type": "object",
          "properties": {
            "ORGANIZATION_ID": {
              "type": "object",
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "description": "The ID of the organization associated with the item"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "The name of the organization associated with the item"
                    },
                    "address": {
                      "type": "string",
                      "description": "The address of the organization"
                    },
                    "cc_email": {
                      "type": "string",
                      "description": "The BCC email of the organization associated with the item"
                    },
                    "owner_id": {
                      "type": "integer",
                      "description": "The ID of the owner of the organization that is associated with the item"
                    },
                    "people_count": {
                      "type": "integer",
                      "description": "The number of people connected with the organization that is associated with the item"
                    }
                  }
                }
              ],
              "description": "The ID of the organization associated with the item"
            }
          }
        }
      }
    }
  }
}

object ActivitiesMarkAsDeletedResponse

{
  "type": "object",
  "title": "deleteActivityResponse200",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "The ID of the activity that was deleted"
        }
      }
    },
    "success": {
      "type": "boolean"
    }
  }
}

object ActivitiesUpdateActivityDetailsRequest

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "org_id": {
          "type": "integer",
          "description": "The ID of the organization this activity is associated with"
        },
        "deal_id": {
          "type": "integer",
          "description": "The ID of the deal this activity is associated with"
        },
        "lead_id": {
          "type": "string",
          "format": "uuid",
          "nullable": true,
          "description": "The ID of the lead in the UUID format this activity is associated with"
        },
        "due_date": {
          "type": "string",
          "format": "date",
          "description": "The due date of the activity. Format: YYYY-MM-DD"
        },
        "due_time": {
          "type": "string",
          "description": "The due time of the activity in UTC. Format: HH:MM"
        },
        "duration": {
          "type": "string",
          "description": "The duration of the activity. Format: HH:MM"
        },
        "location": {
          "type": "string",
          "description": "The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps."
        },
        "person_id": {
          "type": "integer",
          "description": "The ID of the person this activity is associated with"
        },
        "project_id": {
          "type": "integer",
          "nullable": true,
          "description": "The ID of the project this activity is associated with"
        },
        "public_description": {
          "type": "string",
          "description": "Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity."
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "done": {
          "allOf": [
            {
              "enum": [
                0,
                1
              ],
              "type": "number",
              "title": "numberBoolean"
            }
          ],
          "description": "Whether the activity is done or not. 0 = Not done, 1 = Done"
        },
        "note": {
          "type": "string",
          "description": "The note of the activity (HTML format)"
        },
        "type": {
          "type": "string",
          "description": "The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes."
        },
        "subject": {
          "type": "string",
          "description": "The subject of the activity"
        },
        "user_id": {
          "type": "integer",
          "description": "The ID of the user whom the activity is assigned to"
        },
        "attendees": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The attendees of the activity. This can be either your existing Pipedrive contacts or an external email address. It requires a structure as follows: `[{\"email_address\":\"mail@example.org\"}]` or `[{\"person_id\":1, \"email_address\":\"mail@example.org\"}]`"
        },
        "busy_flag": {
          "type": "boolean",
          "description": "Set the activity as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset by never setting it or overriding it with `null`. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time."
        },
        "participants": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "List of multiple persons (participants) this activity is associated with. It requires a structure as follows: `[{\"person_id\":1,\"primary_flag\":true}]`"
        }
      }
    }
  ],
  "title": "updateActivityRequest"
}

object ActivitiesUpdateActivityDetailsResponse

{
  "type": "object",
  "title": "updateActivityResponse200",
  "properties": {
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "org_id": {
              "type": "integer",
              "description": "The ID of the organization this activity is associated with"
            },
            "deal_id": {
              "type": "integer",
              "description": "The ID of the deal this activity is associated with"
            },
            "lead_id": {
              "type": "string",
              "format": "uuid",
              "nullable": true,
              "description": "The ID of the lead in the UUID format this activity is associated with"
            },
            "due_date": {
              "type": "string",
              "format": "date",
              "description": "The due date of the activity. Format: YYYY-MM-DD"
            },
            "due_time": {
              "type": "string",
              "description": "The due time of the activity in UTC. Format: HH:MM"
            },
            "duration": {
              "type": "string",
              "description": "The duration of the activity. Format: HH:MM"
            },
            "location": {
              "type": "string",
              "description": "The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps."
            },
            "person_id": {
              "type": "integer",
              "description": "The ID of the person this activity is associated with"
            },
            "project_id": {
              "type": "integer",
              "nullable": true,
              "description": "The ID of the project this activity is associated with"
            },
            "public_description": {
              "type": "string",
              "description": "Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity."
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer",
              "description": "The ID of the activity, generated when the activity was created"
            },
            "done": {
              "type": "boolean",
              "description": "Whether the activity is done or not"
            },
            "file": {
              "type": "object",
              "description": "The file that is attached to this activity. For example, this can be a reference to an audio note file generated with Pipedrive mobile app."
            },
            "note": {
              "type": "string",
              "description": "The note of the activity (HTML format)"
            },
            "type": {
              "type": "string",
              "description": "The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes."
            },
            "series": {
              "type": "array",
              "items": {
                "type": "object"
              },
              "description": "The list of recurring activity instances. It is in a structure as follows: `[{due_date: \"2020-06-24\", due_time: \"10:00:00\"}]`"
            },
            "subject": {
              "type": "string",
              "description": "The subject of the activity"
            },
            "user_id": {
              "type": "integer",
              "description": "The ID of the user whom the activity is assigned to"
            },
            "add_time": {
              "type": "string",
              "description": "The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS."
            },
            "org_name": {
              "type": "string",
              "description": "The name of the organization this activity is associated with"
            },
            "rec_rule": {
              "type": "string",
              "description": "The rule for the recurrence of the activity. Is important for activities synced into Pipedrive from an external calendar. Example: \"RRULE:FREQ=WEEKLY;BYDAY=WE\""
            },
            "attendees": {
              "type": "array",
              "items": {
                "type": "object"
              },
              "nullable": true,
              "description": "The attendees of the activity. This can be either your existing Pipedrive contacts or an external email address."
            },
            "busy_flag": {
              "type": "boolean",
              "description": "Marks if the activity is set as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time."
            },
            "company_id": {
              "type": "integer",
              "description": "The user's company ID"
            },
            "deal_title": {
              "type": "string",
              "description": "The name of the deal this activity is associated with"
            },
            "owner_name": {
              "type": "string",
              "description": "The name of the user this activity is owned by"
            },
            "active_flag": {
              "type": "boolean",
              "description": "Whether the activity is active or not"
            },
            "person_name": {
              "type": "string",
              "description": "The name of the person this activity is associated with"
            },
            "update_time": {
              "type": "string",
              "description": "The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS."
            },
            "participants": {
              "type": "array",
              "items": {
                "type": "object"
              },
              "nullable": true,
              "description": "List of multiple persons (participants) this activity is associated with"
            },
            "reference_id": {
              "type": "integer",
              "description": "Together with the `reference_type`, gives the ID of the other object"
            },
            "gcal_event_id": {
              "type": "string",
              "description": "For the activity which syncs to Google calendar, this is the Google event ID. NB! This field is related to old Google calendar sync and will be deprecated soon."
            },
            "location_route": {
              "type": "string",
              "description": "A subfield of the location field. Indicates street name."
            },
            "reference_type": {
              "type": "string",
              "description": "If the activity references some other object, it is indicated here. For example, value `Salesphone` refers to activities created with Caller."
            },
            "update_user_id": {
              "type": "integer",
              "description": "The ID of the user who was the last to update this activity"
            },
            "source_timezone": {
              "type": "string",
              "description": "The timezone the activity was created in an external calendar"
            },
            "deal_dropbox_bcc": {
              "type": "string",
              "description": "The BCC email address of the deal"
            },
            "location_country": {
              "type": "string",
              "description": "A subfield of the location field. Indicates country."
            },
            "location_locality": {
              "type": "string",
              "description": "A subfield of the location field. Indicates city/town/village/locality."
            },
            "created_by_user_id": {
              "type": "integer",
              "description": "The ID of the user who created the activity"
            },
            "google_calendar_id": {
              "type": "string",
              "description": "The Google calendar ID that this activity syncs to. NB! This field is related to old Google calendar sync and will be deprecated soon."
            },
            "person_dropbox_bcc": {
              "type": "string",
              "description": "The BCC email address of the person"
            },
            "rec_rule_extension": {
              "type": "string",
              "description": "Additional rules for the recurrence of the activity, extend the `rec_rule`. Is important for activities synced into Pipedrive from an external calendar."
            },
            "assigned_to_user_id": {
              "type": "integer",
              "description": "The ID of the user to whom the activity is assigned to. Equal to `user_id`."
            },
            "location_subpremise": {
              "type": "string",
              "description": "A subfield of the location field. Indicates apartment/suite number."
            },
            "marked_as_done_time": {
              "type": "string",
              "description": "The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS."
            },
            "google_calendar_etag": {
              "type": "string",
              "description": "The Google calendar API etag (version) that is used for syncing this activity. NB! This field is related to old Google calendar sync and will be deprecated soon."
            },
            "location_postal_code": {
              "type": "string",
              "description": "A subfield of the location field. Indicates ZIP/postal code."
            },
            "location_sublocality": {
              "type": "string",
              "description": "A subfield of the location field. Indicates district/sublocality."
            },
            "conference_meeting_id": {
              "type": "string",
              "description": "The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity"
            },
            "conference_meeting_url": {
              "type": "string",
              "description": "The link to join the meeting which is associated with this activity"
            },
            "last_notification_time": {
              "type": "string",
              "description": "The date and time of latest notifications sent about this activity to the participants or the attendees of this activity"
            },
            "location_street_number": {
              "type": "string",
              "description": "A subfield of the location field. Indicates house number."
            },
            "rec_master_activity_id": {
              "type": "integer",
              "description": "The ID of parent activity for a recurrent activity if the current activity is an exception to recurrence rules"
            },
            "notification_language_id": {
              "type": "integer",
              "description": "The ID of the language the notifications are sent in"
            },
            "conference_meeting_client": {
              "type": "string",
              "description": "The ID of the Marketplace app, which is connected to this activity"
            },
            "last_notification_user_id": {
              "type": "integer",
              "description": "The ID of the user who triggered the sending of the latest notifications about this activity to the participants or the attendees of this activity"
            },
            "location_formatted_address": {
              "type": "string",
              "description": "A subfield of the location field. Indicates full/combined address."
            },
            "location_admin_area_level_1": {
              "type": "string",
              "description": "A subfield of the location field. Indicates state/county."
            },
            "location_admin_area_level_2": {
              "type": "string",
              "description": "A subfield of the location field. Indicates region."
            },
            "calendar_sync_include_context": {
              "type": "string",
              "description": "For activities that sync to an external calendar, this setting indicates if the activity syncs with context (what are the deals, persons, organizations this activity is related to)"
            }
          }
        }
      ],
      "title": "activityResponseObject"
    },
    "success": {
      "type": "boolean"
    },
    "related_objects": {
      "type": "object",
      "properties": {
        "deal": {
          "type": "object",
          "properties": {
            "DEAL_ID": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "The ID of the deal associated with the item"
                },
                "title": {
                  "type": "string",
                  "description": "The title of the deal associated with the item"
                },
                "value": {
                  "type": "number",
                  "description": "The value of the deal that is associated with the item"
                },
                "status": {
                  "type": "string",
                  "description": "The status of the deal associated with the item"
                },
                "currency": {
                  "type": "string",
                  "description": "The currency of the deal value"
                },
                "stage_id": {
                  "type": "integer",
                  "description": "The ID of the stage the deal is currently at"
                },
                "pipeline_id": {
                  "type": "integer",
                  "description": "The ID of the pipeline the deal is in"
                }
              },
              "description": "The ID of the deal which is associated with the item"
            }
          }
        },
        "user": {
          "type": "object",
          "properties": {
            "USER_ID": {
              "type": "object",
              "allOf": [
                {
                  "properties": {
                    "id": {
                      "type": "integer",
                      "description": "The ID of the user"
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the user"
                    },
                    "email": {
                      "type": "string",
                      "description": "The email of the user"
                    },
                    "has_pic": {
                      "type": "integer",
                      "description": "Whether the user has picture or not. 0 = No picture, 1 = Has picture."
                    },
                    "pic_hash": {
                      "type": "string",
                      "nullable": true,
                      "description": "The user picture hash"
                    },
                    "active_flag": {
                      "type": "boolean",
                      "description": "Whether the user is active or not"
                    }
                  }
                },
                {
                  "type": "object",
                  "description": "The ID of the user"
                }
              ],
              "title": "userDataWithId"
            }
          }
        },
        "person": {
          "type": "object",
          "properties": {
            "PERSON_ID": {
              "type": "object",
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "active_flag": {
                      "type": "boolean",
                      "description": "Whether the associated person is active or not"
                    }
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "description": "The ID of the person associated with the item"
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the person associated with the item"
                    },
                    "email": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "label": {
                            "type": "string",
                            "description": "The type of the email"
                          },
                          "value": {
                            "type": "string",
                            "description": "The email of the associated person"
                          },
                          "primary": {
                            "type": "boolean",
                            "description": "Whether this is the primary email or not"
                          }
                        }
                      },
                      "description": "The emails of the person associated with the item"
                    },
                    "phone": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "label": {
                            "type": "string",
                            "description": "The type of the phone number"
                          },
                          "value": {
                            "type": "string",
                            "description": "The phone number of the person associated with the item"
                          },
                          "primary": {
                            "type": "boolean",
                            "description": "Whether this is the primary phone number or not"
                          }
                        }
                      },
                      "description": "The phone numbers of the person associated with the item"
                    },
                    "owner_id": {
                      "type": "integer",
                      "description": "The ID of the owner of the person that is associated with the item"
                    }
                  }
                }
              ],
              "description": "The ID of the person associated with the item"
            }
          }
        },
        "organization": {
          "type": "object",
          "properties": {
            "ORGANIZATION_ID": {
              "type": "object",
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "active_flag": {
                      "type": "boolean",
                      "description": "Whether the associated organization is active or not"
                    }
                  }
                },
                {
                  "type": "object",
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "description": "The ID of the organization associated with the item"
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "description": "The name of the organization associated with the item"
                        },
                        "address": {
                          "type": "string",
                          "description": "The address of the organization"
                        },
                        "cc_email": {
                          "type": "string",
                          "description": "The BCC email of the organization associated with the item"
                        },
                        "owner_id": {
                          "type": "integer",
                          "description": "The ID of the owner of the organization that is associated with the item"
                        },
                        "people_count": {
                          "type": "integer",
                          "description": "The number of people connected with the organization that is associated with the item"
                        }
                      }
                    }
                  ],
                  "description": "The ID of the organization associated with the item"
                }
              ],
              "description": "The ID of the organization associated with the item"
            }
          }
        }
      }
    }
  }
}

object ActivityFieldsGetAllResponse

{
  "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. Value is `null` in case of subfields."
              },
              "key": {
                "type": "string",
                "description": "The key of the field. For custom fields this is generated upon creation."
              },
              "name": {
                "type": "string",
                "description": "The name of the field"
              },
              "options": {
                "type": "array",
                "items": {
                  "type": "object"
                },
                "nullable": true,
                "description": "The options of the field. When there are no options, `null` is returned."
              },
              "add_time": {
                "type": "string",
                "format": "date-time",
                "description": "The creation time of the field"
              },
              "order_nr": {
                "type": "integer",
                "description": "The order number of the field"
              },
              "edit_flag": {
                "type": "boolean",
                "description": "The edit flag of the field"
              },
              "subfields": {
                "type": "array",
                "items": {
                  "type": "object"
                },
                "description": "The subfields of the field. Only present when the field has subfields."
              },
              "field_type": {
                "allOf": [
                  {
                    "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"
              },
              "is_subfield": {
                "type": "boolean",
                "description": "Whether or not the field is a subfield of another field. Only present if field is subfield."
              },
              "update_time": {
                "type": "string",
                "format": "date-time",
                "description": "The update time of the field"
              },
              "sortable_flag": {
                "type": "boolean",
                "description": "Whether or not items can be sorted by this field"
              },
              "important_flag": {
                "type": "boolean",
                "description": "Not used"
              },
              "mandatory_flag": {
                "type": "boolean",
                "description": "Whether or not the field is mandatory"
              },
              "options_deleted": {
                "type": "array",
                "items": {
                  "type": "object"
                },
                "description": "The deleted options of the field. Only present when there is at least 1 deleted option."
              },
              "searchable_flag": {
                "type": "boolean",
                "description": "Whether or not items can be searched by this field"
              },
              "add_visible_flag": {
                "type": "boolean",
                "description": "Not used"
              },
              "bulk_edit_allowed": {
                "type": "boolean",
                "description": "Whether or not the field of an item can be edited in bulk"
              },
              "filtering_allowed": {
                "type": "boolean",
                "description": "Whether or not items can be filtered by this field"
              },
              "index_visible_flag": {
                "type": "boolean",
                "description": "Not used"
              },
              "details_visible_flag": {
                "type": "boolean",
                "description": "Not used"
              },
              "last_updated_by_user_id": {
                "type": "integer",
                "description": "The ID of the user who created or most recently updated the field, only applicable for custom fields"
              }
            }
          }
        },
        "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": "fieldsResponse200"
}

object ActivityTypesAddNewTypeRequest

{
  "type": "object",
  "title": "addActivityTypeRequest",
  "required": [
    "name",
    "icon_key"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "call",
      "description": "The name of the activity type"
    },
    "color": {
      "type": "string",
      "example": "FFFFFF",
      "description": "A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)"
    },
    "icon_key": {
      "enum": [
        "task",
        "email",
        "meeting",
        "deadline",
        "call",
        "lunch",
        "calendar",
        "downarrow",
        "document",
        "smartphone",
        "camera",
        "scissors",
        "cogs",
        "bubble",
        "uparrow",
        "checkbox",
        "signpost",
        "shuffle",
        "addressbook",
        "linegraph",
        "picture",
        "car",
        "world",
        "search",
        "clip",
        "sound",
        "brush",
        "key",
        "padlock",
        "pricetag",
        "suitcase",
        "finish",
        "plane",
        "loop",
        "wifi",
        "truck",
        "cart",
        "bulb",
        "bell",
        "presentation"
      ],
      "type": "string",
      "description": "Icon graphic to use for representing this activity type"
    }
  }
}

object ActivityTypesAddNewTypeResponse

{
  "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 activity type"
            },
            "name": {
              "type": "string",
              "description": "The name of the activity type"
            },
            "color": {
              "type": "string",
              "description": "A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)"
            },
            "add_time": {
              "type": "string",
              "format": "date-time",
              "description": "The creation time of the activity type"
            },
            "icon_key": {
              "enum": [
                "task",
                "email",
                "meeting",
                "deadline",
                "call",
                "lunch",
                "calendar",
                "downarrow",
                "document",
                "smartphone",
                "camera",
                "scissors",
                "cogs",
                "bubble",
                "uparrow",
                "checkbox",
                "signpost",
                "shuffle",
                "addressbook",
                "linegraph",
                "picture",
                "car",
                "world",
                "search",
                "clip",
                "sound",
                "brush",
                "key",
                "padlock",
                "pricetag",
                "suitcase",
                "finish",
                "plane",
                "loop",
                "wifi",
                "truck",
                "cart",
                "bulb",
                "bell",
                "presentation"
              ],
              "type": "string",
              "description": "Icon graphic to use for representing this activity type"
            },
            "order_nr": {
              "type": "integer",
              "description": "An order number for the activity type. Order numbers should be used to order the types in the activity type selections."
            },
            "key_string": {
              "type": "string",
              "description": "A string that is generated by the API based on the given name of the activity type upon creation"
            },
            "active_flag": {
              "type": "boolean",
              "description": "The active flag of the activity type"
            },
            "update_time": {
              "type": "string",
              "format": "date-time",
              "description": "The update time of the activity type"
            },
            "is_custom_flag": {
              "type": "boolean",
              "description": "Whether the activity type is a custom one or not"
            }
          }
        }
      }
    }
  ],
  "title": "createUpdateDeleteActivityTypeResponse200"
}

object ActivityTypesListAllActivityTypesResponse

{
  "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 activity type"
              },
              "name": {
                "type": "string",
                "description": "The name of the activity type"
              },
              "color": {
                "type": "string",
                "description": "A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)"
              },
              "add_time": {
                "type": "string",
                "format": "date-time",
                "description": "The creation time of the activity type"
              },
              "icon_key": {
                "enum": [
                  "task",
                  "email",
                  "meeting",
                  "deadline",
                  "call",
                  "lunch",
                  "calendar",
                  "downarrow",
                  "document",
                  "smartphone",
                  "camera",
                  "scissors",
                  "cogs",
                  "bubble",
                  "uparrow",
                  "checkbox",
                  "signpost",
                  "shuffle",
                  "addressbook",
                  "linegraph",
                  "picture",
                  "car",
                  "world",
                  "search",
                  "clip",
                  "sound",
                  "brush",
                  "key",
                  "padlock",
                  "pricetag",
                  "suitcase",
                  "finish",
                  "plane",
                  "loop",
                  "wifi",
                  "truck",
                  "cart",
                  "bulb",
                  "bell",
                  "presentation"
                ],
                "type": "string",
                "description": "Icon graphic to use for representing this activity type"
              },
              "order_nr": {
                "type": "integer",
                "description": "An order number for the activity type. Order numbers should be used to order the types in the activity type selections."
              },
              "key_string": {
                "type": "string",
                "description": "A string that is generated by the API based on the given name of the activity type upon creation"
              },
              "active_flag": {
                "type": "boolean",
                "description": "The active flag of the activity type"
              },
              "update_time": {
                "type": "string",
                "format": "date-time",
                "description": "The update time of the activity type"
              },
              "is_custom_flag": {
                "type": "boolean",
                "description": "Whether the activity type is a custom one or not"
              }
            }
          },
          "description": "The array of activity types"
        }
      }
    }
  ],
  "title": "getActivityTypesResponse200"
}

object ActivityTypesMarkAsDeletedBulkResponse

{
  "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": "array",
              "items": {
                "type": "integer"
              },
              "description": "The IDs of the deleted activity types"
            }
          }
        }
      }
    }
  ],
  "title": "deleteActivityTypesResponse200"
}

object ActivityTypesMarkAsDeletedResponse

{
  "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 activity type"
            },
            "name": {
              "type": "string",
              "description": "The name of the activity type"
            },
            "color": {
              "type": "string",
              "description": "A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)"
            },
            "add_time": {
              "type": "string",
              "format": "date-time",
              "description": "The creation time of the activity type"
            },
            "icon_key": {
              "enum": [
                "task",
                "email",
                "meeting",
                "deadline",
                "call",
                "lunch",
                "calendar",
                "downarrow",
                "document",
                "smartphone",
                "camera",
                "scissors",
                "cogs",
                "bubble",
                "uparrow",
                "checkbox",
                "signpost",
                "shuffle",
                "addressbook",
                "linegraph",
                "picture",
                "car",
                "world",
                "search",
                "clip",
                "sound",
                "brush",
                "key",
                "padlock",
                "pricetag",
                "suitcase",
                "finish",
                "plane",
                "loop",
                "wifi",
                "truck",
                "cart",
                "bulb",
                "bell",
                "presentation"
              ],
              "type": "string",
              "description": "Icon graphic to use for representing this activity type"
            },
            "order_nr": {
              "type": "integer",
              "description": "An order number for the activity type. Order numbers should be used to order the types in the activity type selections."
            },
            "key_string": {
              "type": "string",
              "description": "A string that is generated by the API based on the given name of the activity type upon creation"
            },
            "active_flag": {
              "type": "boolean",
              "description": "The active flag of the activity type"
            },
            "update_time": {
              "type": "string",
              "format": "date-time",
              "description": "The update time of the activity type"
            },
            "is_custom_flag": {
              "type": "boolean",
              "description": "Whether the activity type is a custom one or not"
            }
          }
        }
      }
    }
  ],
  "title": "createUpdateDeleteActivityTypeResponse200"
}

object ActivityTypesUpdateTypeRequest

{
  "type": "object",
  "title": "updateActivityTypeRequest",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the activity type"
    },
    "color": {
      "type": "string",
      "description": "A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)"
    },
    "icon_key": {
      "enum": [
        "task",
        "email",
        "meeting",
        "deadline",
        "call",
        "lunch",
        "calendar",
        "downarrow",
        "document",
        "smartphone",
        "camera",
        "scissors",
        "cogs",
        "bubble",
        "uparrow",
        "checkbox",
        "signpost",
        "shuffle",
        "addressbook",
        "linegraph",
        "picture",
        "car",
        "world",
        "search",
        "clip",
        "sound",
        "brush",
        "key",
        "padlock",
        "pricetag",
        "suitcase",
        "finish",
        "plane",
        "loop",
        "wifi",
        "truck",
        "cart",
        "bulb",
        "bell",
        "presentation"
      ],
      "type": "string",
      "description": "Icon graphic to use for representing this activity type"
    },
    "order_nr": {
      "type": "integer",
      "description": "An order number for this activity type. Order numbers should be used to order the types in the activity type selections."
    }
  }
}

object ActivityTypesUpdateTypeResponse

{
  "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 activity type"
            },
            "name": {
              "type": "string",
              "description": "The name of the activity type"
            },
            "color": {
              "type": "string",
              "description": "A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)"
            },
            "add_time": {
              "type": "string",
              "format": "date-time",
              "description": "The creation time of the activity type"
            },
            "icon_key": {
              "enum": [
                "task",
                "email",
                "meeting",
                "deadline",
                "call",
                "lunch",
                "calendar",
                "downarrow",
                "document",
                "smartphone",
                "camera",
                "scissors",
                "cogs",
                "bubble",
                "uparrow",
                "checkbox",
                "signpost",
                "shuffle",
                "addressbook",
                "linegraph",
                "picture",
                "car",
                "world",
                "search",
                "clip",
                "sound",
                "brush",
                "key",
                "padlock",
                "pricetag",
                "suitcase",
                "finish",
                "plane",
                "loop",
                "wifi",
                "truck",
                "cart",
                "bulb",
                "bell",
                "presentation"
              ],
              "type": "string",
              "description": "Icon graphic to use for representing this activity type"
            },
            "order_nr": {
              "type": "integer",
              "description": "An order number for the activity type. Order numbers should be used to order the types in the activity type selections."
            },
            "key_string": {
              "type": "string",
              "description": "A string that is generated by the API based on the given name of the activity type upon creation"
            },
            "active_flag": {
              "type": "boolean",
              "description": "The active flag of the activity type"
            },
            "update_time": {
              "type": "string",
              "format": "date-time",
              "description": "The update time of the activity type"
            },
            "is_custom_flag": {
              "type": "boolean",
              "description": "Whether the activity type is a custom one or not"
            }
          }
        }
      }
    }
  ],
  "title": "createUpdateDeleteActivityTypeResponse200"
}

object BillingGetAddonsForSingleCompanyResponse

{
  "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"
          },
          "description": "An array of add-ons that the company has."
        }
      }
    }
  ],
  "title": "subscriptionAddonsResponse200"
}

object CallLogsAddNewLog400Response

{
  "type": "object",
  "title": "callLogResponse400",
  "properties": {
    "data": {
      "type": "object",
      "example": null,
      "nullable": true
    },
    "error": {
      "type": "string",
      "example": "\"outcome\" is required.",
      "description": "The description of the error"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check developers.pipedrive.com for more information about Pipedrive API.",
      "description": "A message describing how to solve the problem"
    },
    "additional_data": {
      "type": "object",
      "example": null,
      "nullable": true
    }
  }
}

object CallLogsAddNewLog403Response

{
  "type": "object",
  "title": "callLogResponse403",
  "properties": {
    "data": {
      "type": "object",
      "example": null,
      "nullable": true
    },
    "error": {
      "type": "string",
      "example": "You don't have permission to change this resource.",
      "description": "The description of the error"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check developers.pipedrive.com for more information about Pipedrive API.",
      "description": "A message describing how to solve the problem"
    },
    "additional_data": {
      "type": "object",
      "example": null,
      "nullable": true
    }
  }
}

object CallLogsAddNewLog404Response

{
  "type": "object",
  "title": "callLogResponse404",
  "properties": {
    "data": {
      "type": "object",
      "example": null,
      "nullable": true
    },
    "error": {
      "type": "string",
      "example": "A resource required for this operation was not found.",
      "description": "The description of the error"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check developers.pipedrive.com for more information about Pipedrive API.",
      "description": "A message describing how to solve the problem"
    },
    "additional_data": {
      "type": "object",
      "example": null,
      "nullable": true
    }
  }
}

object CallLogsAddNewLog500Response

{
  "type": "object",
  "title": "callLogResponse500",
  "properties": {
    "data": {
      "type": "object",
      "example": null,
      "nullable": true
    },
    "error": {
      "type": "string",
      "example": "An internal server error occurred",
      "description": "The description of the error"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check developers.pipedrive.com for more information about Pipedrive API.",
      "description": "A message describing how to solve the problem"
    },
    "additional_data": {
      "type": "object",
      "example": null,
      "nullable": true
    }
  }
}

object CallLogsAddNewLogRequest

{
  "type": "object",
  "title": "addCallLogRequest",
  "required": [
    "to_phone_number",
    "outcome",
    "start_time",
    "end_time"
  ],
  "properties": {
    "note": {
      "type": "string",
      "description": "The note for the call log in HTML format"
    },
    "org_id": {
      "type": "integer",
      "description": "The ID of the organization this call is associated with"
    },
    "deal_id": {
      "type": "integer",
      "description": "The ID of the deal this call is associated with. A call log can be associated with either a deal or a lead, but not both at once."
    },
    "lead_id": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the lead in the UUID format this call is associated with. A call log can be associated with either a deal or a lead, but not both at once."
    },
    "outcome": {
      "enum": [
        "connected",
        "no_answer",
        "left_message",
        "left_voicemail",
        "wrong_number",
        "busy"
      ],
      "type": "string",
      "description": "Describes the outcome of the call"
    },
    "subject": {
      "type": "string",
      "description": "The name of the activity this call is attached to"
    },
    "user_id": {
      "type": "integer",
      "description": "The ID of the owner of the call log. Please note that a user without account settings access cannot create call logs for other users."
    },
    "duration": {
      "type": "string",
      "description": "The duration of the call in seconds"
    },
    "end_time": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS."
    },
    "person_id": {
      "type": "integer",
      "description": "The ID of the person this call is associated with"
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS."
    },
    "activity_id": {
      "type": "integer",
      "description": "If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity. The `activity_id` must refer to a `call` type activity."
    },
    "to_phone_number": {
      "type": "string",
      "description": "The number called"
    },
    "from_phone_number": {
      "type": "string",
      "description": "The number that made the call"
    }
  }
}

object CallLogsAddNewLogResponse

{
  "type": "object",
  "title": "callLogResponse200",
  "properties": {
    "data": {
      "allOf": [
        {
          "type": "object",
          "title": "addCallLogRequest",
          "required": [
            "to_phone_number",
            "outcome",
            "start_time",
            "end_time"
          ],
          "properties": {
            "note": {
              "type": "string",
              "description": "The note for the call log in HTML format"
            },
            "org_id": {
              "type": "integer",
              "description": "The ID of the organization this call is associated with"
            },
            "deal_id": {
              "type": "integer",
              "description": "The ID of the deal this call is associated with. A call log can be associated with either a deal or a lead, but not both at once."
            },
            "lead_id": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the lead in the UUID format this call is associated with. A call log can be associated with either a deal or a lead, but not both at once."
            },
            "outcome": {
              "enum": [
                "connected",
                "no_answer",
                "left_message",
                "left_voicemail",
                "wrong_number",
                "busy"
              ],
              "type": "string",
              "description": "Describes the outcome of the call"
            },
            "subject": {
              "type": "string",
              "description": "The name of the activity this call is attached to"
            },
            "user_id": {
              "type": "integer",
              "description": "The ID of the owner of the call log. Please note that a user without account settings access cannot create call logs for other users."
            },
            "duration": {
              "type": "string",
              "description": "The duration of the call in seconds"
            },
            "end_time": {
              "type": "string",
              "format": "date-time",
              "description": "The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS."
            },
            "person_id": {
              "type": "integer",
              "description": "The ID of the person this call is associated with"
            },
            "start_time": {
              "type": "string",
              "format": "date-time",
              "description": "The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS."
            },
            "activity_id": {
              "type": "integer",
              "description": "If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity. The `activity_id` must refer to a `call` type activity."
            },
            "to_phone_number": {
              "type": "string",
              "description": "The number called"
            },
            "from_phone_number": {
              "type": "string",
              "description": "The number that made the call"
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "The call log ID, generated when the call log was created"
            },
            "company_id": {
              "type": "integer",
              "description": "The company ID of the owner of the call log"
            },
            "has_recording": {
              "type": "boolean",
              "description": "If the call log has an audio recording attached, the value should be true"
            }
          }
        }
      ],
      "title": "responseCallLogObject"
    },
    "success": {
      "type": "boolean",
      "description": "If the response is successful or not"
    }
  }
}

object CallLogsAttachRecording404Response

{
  "type": "object",
  "title": "callLogResponse404",
  "properties": {
    "data": {
      "type": "object",
      "example": null,
      "nullable": true
    },
    "error": {
      "type": "string",
      "example": "A resource required for this operation was not found.",
      "description": "The description of the error"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check developers.pipedrive.com for more information about Pipedrive API.",
      "description": "A message describing how to solve the problem"
    },
    "additional_data": {
      "type": "object",
      "example": null,
      "nullable": true
    }
  }
}

object CallLogsAttachRecording409Response

{
  "type": "object",
  "title": "callLogResponse409",
  "properties": {
    "data": {
      "type": "object",
      "example": null,
      "nullable": true
    },
    "error": {
      "type": "string",
      "example": "A recording for this call already exists",
      "description": "The description of the error"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check developers.pipedrive.com for more information about Pipedrive API.",
      "description": "A message describing how to solve the problem"
    },
    "additional_data": {
      "type": "object",
      "example": null,
      "nullable": true
    }
  }
}

object CallLogsAttachRecording500Response

{
  "type": "object",
  "title": "callLogResponse500",
  "properties": {
    "data": {
      "type": "object",
      "example": null,
      "nullable": true
    },
    "error": {
      "type": "string",
      "example": "An internal server error occurred",
      "description": "The description of the error"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check developers.pipedrive.com for more information about Pipedrive API.",
      "description": "A message describing how to solve the problem"
    },
    "additional_data": {
      "type": "object",
      "example": null,
      "nullable": true
    }
  }
}

object CallLogsAttachRecordingRequest

{
  "type": "object",
  "title": "addCallLogAudioFileRequest",
  "required": [
    "file"
  ],
  "properties": {
    "file": {
      "type": "string",
      "format": "binary",
      "description": "Audio file supported by the HTML5 specification"
    }
  }
}

object CallLogsAttachRecordingResponse

{
  "type": "object",
  "title": "baseResponse",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "If the response is successful or not"
    }
  }
}

object CallLogsDeleteLog403Response

{
  "type": "object",
  "title": "callLogResponse403",
  "properties": {
    "data": {
      "type": "object",
      "example": null,
      "nullable": true
    },
    "error": {
      "type": "string",
      "example": "You don't have permission to change this resource.",
      "description": "The description of the error"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check developers.pipedrive.com for more information about Pipedrive API.",
      "description": "A message describing how to solve the problem"
    },
    "additional_data": {
      "type": "object",
      "example": null,
      "nullable": true
    }
  }
}

object CallLogsDeleteLog404Response

{
  "type": "object",
  "title": "callLogResponse404",
  "properties": {
    "data": {
      "type": "object",
      "example": null,
      "nullable": true
    },
    "error": {
      "type": "string",
      "example": "A resource required for this operation was not found.",
      "description": "The description of the error"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check developers.pipedrive.com for more information about Pipedrive API.",
      "description": "A message describing how to solve the problem"
    },
    "additional_data": {
      "type": "object",
      "example": null,
      "nullable": true
    }
  }
}

object CallLogsDeleteLog410Response

{
  "type": "object",
  "title": "callLogResponse410",
  "properties": {
    "data": {
      "type": "object",
      "example": null,
      "nullable": true
    },
    "error": {
      "type": "string",
      "example": "The callLog you are trying to access is no longer available",
      "description": "The description of the error"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check developers.pipedrive.com for more information about Pipedrive API.",
      "description": "A message describing how to solve the problem"
    },
    "additional_data": {
      "type": "object",
      "example": null,
      "nullable": true
    }
  }
}

object CallLogsDeleteLog500Response

{
  "type": "object",
  "title": "callLogResponse500",
  "properties": {
    "data": {
      "type": "object",
      "example": null,
      "nullable": true
    },
    "error": {
      "type": "string",
      "example": "An internal server error occurred",
      "description": "The description of the error"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check developers.pipedrive.com for more information about Pipedrive API.",
      "description": "A message describing how to solve the problem"
    },
    "additional_data": {
      "type": "object",
      "example": null,
      "nullable": true
    }
  }
}

object CallLogsDeleteLogResponse

{
  "type": "object",
  "title": "baseResponse",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "If the response is successful or not"
    }
  }
}

object CallLogsGetAllLogsResponse

{
  "type": "object",
  "title": "callLogsResponse",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "title": "addCallLogRequest",
            "required": [
              "to_phone_number",
              "outcome",
              "start_time",
              "end_time"
            ],
            "properties": {
              "note": {
                "type": "string",
                "description": "The note for the call log in HTML format"
              },
              "org_id": {
                "type": "integer",
                "description": "The ID of the organization this call is associated with"
              },
              "deal_id": {
                "type": "integer",
                "description": "The ID of the deal this call is associated with. A call log can be associated with either a deal or a lead, but not both at once."
              },
              "lead_id": {
                "type": "string",
                "format": "uuid",
                "description": "The ID of the lead in the UUID format this call is associated with. A call log can be associated with either a deal or a lead, but not both at once."
              },
              "outcome": {
                "enum": [
                  "connected",
                  "no_answer",
                  "left_message",
                  "left_voicemail",
                  "wrong_number",
                  "busy"
                ],
                "type": "string",
                "description": "Describes the outcome of the call"
              },
              "subject": {
                "type": "string",
                "description": "The name of the activity this call is attached to"
              },
              "user_id": {
                "type": "integer",
                "description": "The ID of the owner of the call log. Please note that a user without account settings access cannot create call logs for other users."
              },
              "duration": {
                "type": "string",
                "description": "The duration of the call in seconds"
              },
              "end_time": {
                "type": "string",
                "format": "date-time",
                "description": "The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS."
              },
              "person_id": {
                "type": "integer",
                "description": "The ID of the person this call is associated with"
              },
              "start_time": {
                "type": "string",
                "format": "date-time",
                "description": "The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS."
              },
              "activity_id": {
                "type": "integer",
                "description": "If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity. The `activity_id` must refer to a `call` type activity."
              },
              "to_phone_number": {
                "type": "string",
                "description": "The number called"
              },
              "from_phone_number": {
                "type": "string",
                "description": "The number that made the call"
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "The call log ID, generated when the call log was created"
              },
              "company_id": {
                "type": "integer",
                "description": "The company ID of the owner of the call log"
              },
              "has_recording": {
                "type": "boolean",
                "description": "If the call log has an audio recording attached, the value should be true"
              }
            }
          }
        ],
        "title": "responseCallLogObject"
      }
    },
    "success": {
      "type": "boolean",
      "description": "If the response is successful or not"
    },
    "additional_data": {
      "type": "object",
      "properties": {
        "pagination": {
          "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"
        }
      }
    }
  }
}

object CallLogsGetDetails404Response

{
  "type": "object",
  "title": "callLogResponse404",
  "properties": {
    "data": {
      "type": "object",
      "example": null,
      "nullable": true
    },
    "error": {
      "type": "string",
      "example": "A resource required for this operation was not found.",
      "description": "The description of the error"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check developers.pipedrive.com for more information about Pipedrive API.",
      "description": "A message describing how to solve the problem"
    },
    "additional_data": {
      "type": "object",
      "example": null,
      "nullable": true
    }
  }
}

object CallLogsGetDetailsResponse

{
  "type": "object",
  "title": "callLogResponse200",
  "properties": {
    "data": {
      "allOf": [
        {
          "type": "object",
          "title": "addCallLogRequest",
          "required": [
            "to_phone_number",
            "outcome",
            "start_time",
            "end_time"
          ],
          "properties": {
            "note": {
              "type": "string",
              "description": "The note for the call log in HTML format"
            },
            "org_id": {
              "type": "integer",
              "description": "The ID of the organization this call is associated with"
            },
            "deal_id": {
              "type": "integer",
              "description": "The ID of the deal this call is associated with. A call log can be associated with either a deal or a lead, but not both at once."
            },
            "lead_id": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the lead in the UUID format this call is associated with. A call log can be associated with either a deal or a lead, but not both at once."
            },
            "outcome": {
              "enum": [
                "connected",
                "no_answer",
                "left_message",
                "left_voicemail",
                "wrong_number",
                "busy"
              ],
              "type": "string",
              "description": "Describes the outcome of the call"
            },
            "subject": {
              "type": "string",
              "description": "The name of the activity this call is attached to"
            },
            "user_id": {
              "type": "integer",
              "description": "The ID of the owner of the call log. Please note that a user without account settings access cannot create call logs for other users."
            },
            "duration": {
              "type": "string",
              "description": "The duration of the call in seconds"
            },
            "end_time": {
              "type": "string",
              "format": "date-time",
              "description": "The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS."
            },
            "person_id": {
              "type": "integer",
              "description": "The ID of the person this call is associated with"
            },
            "start_time": {
              "type": "string",
              "format": "date-time",
              "description": "The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS."
            },
            "activity_id": {
              "type": "integer",
              "description": "If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity. The `activity_id` must refer to a `call` type activity."
            },
            "to_phone_number": {
              "type": "string",
              "description": "The number called"
            },
            "from_phone_number": {
              "type": "string",
              "description": "The number that made the call"
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "The call log ID, generated when the call log was created"
            },
            "company_id": {
              "type": "integer",
              "description": "The company ID of the owner of the call log"
            },
            "has_recording": {
              "type": "boolean",
              "description": "If the call log has an audio recording attached, the value should be true"
            }
          }
        }
      ],
      "title": "responseCallLogObject"
    },
    "success": {
      "type": "boolean",
      "description": "If the response is successful or not"
    }
  }
}

object ChannelsCreateNewChannel400Response

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "example": "Expected { name: string; avatar_url?: string; provider_channel_id: string; }, but was incompatible",
      "description": "The error description"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check the reference docs in https://developers.pipedrive.com/docs/api/v1"
    },
    "additional_data": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "example": "INVALID_BODY",
          "description": "An error code sent by the API"
        }
      }
    }
  }
}

object ChannelsCreateNewChannel403Response

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "example": "Only admins can register channels",
      "description": "The error description"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check the reference docs in https://developers.pipedrive.com/docs/api/v1"
    },
    "additional_data": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "example": "ADMIN_ONLY",
          "description": "An error code sent by the API"
        }
      }
    }
  }
}

object ChannelsCreateNewChannelRequest

{
  "type": "object",
  "required": [
    "name",
    "provider_channel_id"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "My Channel",
      "description": "The name of the channel"
    },
    "avatar_url": {
      "type": "string",
      "format": "url",
      "description": "The URL for an icon that represents your channel"
    },
    "provider_type": {
      "enum": [
        "facebook",
        "whatsapp",
        "other"
      ],
      "type": "string",
      "default": "other",
      "description": "It controls the icons (like the icon next to the conversation)"
    },
    "template_support": {
      "type": "boolean",
      "default": false,
      "description": "If true, enables templates logic on UI. Requires getTemplates endpoint implemented. Find out more [here](https://pipedrive.readme.io/docs/implementing-messaging-app-extension)."
    },
    "provider_channel_id": {
      "type": "string",
      "description": "The channel ID"
    }
  }
}

object ChannelsCreateNewChannelResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique channel ID used internally in omnichannel-api and the frontend of the extension"
        },
        "name": {
          "type": "string",
          "example": "My Channel",
          "description": "The name of the channel"
        },
        "avatar_url": {
          "type": "string",
          "example": "http://some-domain.com/test.jpg",
          "description": "The URL for an icon that represents your channel"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time when your channel was created in the API"
        },
        "pd_user_id": {
          "type": "integer",
          "example": 1,
          "description": "The ID of the user in Pipedrive"
        },
        "pd_company_id": {
          "type": "integer",
          "example": 1,
          "description": "The ID of the user's company in Pipedrive"
        },
        "provider_type": {
          "enum": [
            "facebook",
            "whatsapp",
            "other"
          ],
          "type": "string",
          "description": "Value of the provider_type sent to this endpoint"
        },
        "template_support": {
          "type": "boolean",
          "description": "Value of the template_support sent to this endpoint"
        },
        "provider_channel_id": {
          "type": "string",
          "format": "string",
          "description": "The channel ID you specified while creating the channel"
        },
        "marketplace_client_id": {
          "type": "string",
          "description": "The client_id of your app in Pipedrive marketplace"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

object ChannelsDeleteChannelById400Response

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "example": "Expected { name: string; avatar_url?: string; provider_channel_id: string; }, but was incompatible",
      "description": "The error description"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check the reference docs in https://developers.pipedrive.com/docs/api/v1"
    },
    "additional_data": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "example": "INVALID_BODY",
          "description": "An error code sent by the API"
        }
      }
    }
  }
}

object ChannelsDeleteChannelByIdResponse

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

object ChannelsDeleteConversation403Response

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "example": "Only the app owner can delete conversations",
      "description": "The error description"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check the reference docs in https://developers.pipedrive.com/docs/api/v1"
    },
    "additional_data": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "example": "FORBIDDEN_USER_REQUEST",
          "description": "An error code sent by the API"
        }
      }
    }
  }
}

object ChannelsDeleteConversation404Response

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "example": "Channel not found.",
      "description": "The error description"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check the reference docs in https://developers.pipedrive.com/docs/api/v1"
    },
    "additional_data": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "example": "NOT_FOUND",
          "description": "An error code sent by the API"
        }
      }
    }
  }
}

object ChannelsDeleteConversationResponse

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

object ChannelsReceiveMessage400Response

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "example": "Expected { id: string; sender_id: string; conversation_id: string; conversation_link?: string; channel_id: string; created_at: string; message: string; status: unknown; attachments: { id: string; type: string; name: string | null; size: number | null; url: string; preview_url: string | null; }[]; reply_by?: string | null; }, but was incompatible",
      "description": "The error description"
    },
    "success": {
      "type": "boolean",
      "example": false
    },
    "error_info": {
      "type": "string",
      "example": "Please check the reference docs in https://developers.pipedrive.com/docs/api/v1"
    },
    "additional_data": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "example": "INVALID_RECEIVE_MESSAGE_PAYLOAD",
          "description": "An error code sent by the API"
        }
      }
    }
  }
}

object ChannelsReceiveMessageRequest

{
  "type": "object",
  "required": [
    "id",
    "channel_id",
    "sender_id",
    "conversation_id",
    "message",
    "status",
    "created_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the message"
    },
    "status": {
      "enum": [
        "sent",
        "delivered",
        "read",
        "failed"
      ],
      "type": "string",
      "description": "The status of the message"
    },
    "message": {
      "type": "string",
      "description": "The body of the message"
    },
    "reply_by": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the message can no longer receive a reply, in UTC. Format: YYYY-MM-DD HH:MM"
    },
    "sender_id": {
      "type": "string",
      "description": "The ID of the provider's user that sent the message"
    },
    "channel_id": {
      "type": "string",
      "description": "The channel ID as in the provider"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the message was created in the provider, in UTC. Format: YYYY-MM-DD HH:MM"
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "type",
          "url"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the attachment"
          },
          "url": {
            "type": "string",
            "description": "A URL to the file"
          },
          "name": {
            "type": "string",
            "description": "The name of the attachment"
          },
          "size": {
            "type": "number",
            "description": "The size of the attachment"
          },
          "type": {
            "type": "string",
            "description": "The mime-type of the attachment"
          },
          "preview_url": {
            "type": "string",
            "description": "A URL to a preview picture of the file"
          },
          "link_expires": {
            "type": "boolean",
            "default": false,
            "description": "If true, it will use the getMessageById endpoint for fetching updated attachment's urls. Find out more [here](https://pipedrive.readme.io/docs/implementing-messaging-app-extension)"
          }
        }
      },
      "description": "The list of attachments available in the message"
    },
    "conversation_id": {
      "type": "string",
      "description": "The ID of the conversation"
    },
    "conversation_link": {
      "type": "string",
      "format": "url",
      "description": "A URL that can open the conversation in the provider's side"
    }
  }
}

object ChannelsReceiveMessageResponse

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "id",
        "channel_id",
        "sender_id",
        "conversation_id",
        "message",
        "status",
        "created_at"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the message"
        },
        "status": {
          "enum": [
            "sent",
            "delivered",
            "read",
            "failed"
          ],
          "type": "string",
          "description": "The status of the message"
        },
        "message": {
          "type": "string",
          "description": "The body of the message"
        },
        "reply_by": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time when the message can no longer receive a reply, in UTC. Format: YYYY-MM-DD HH:MM"
        },
        "sender_id": {
          "type": "string",
          "description": "The ID of the provider's user that sent the message"
        },
        "channel_id": {
          "type": "string",
          "description": "The channel ID as in the provider"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time when the message was created in the provider, in UTC. Format: YYYY-MM-DD HH:MM"
        },
        "attachments": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "type",
              "url"
            ],
            "properties": {
              "id": {
                "type": "string",
                "description": "The ID of the attachment"
              },
              "url": {
                "type": "string",
                "description": "A URL to the file"
              },
              "name": {
                "type": "string",
                "description": "The name of the attachment"
              },
              "size": {
                "type": "number",
                "description": "The size of the attachment"
              },
              "type": {
                "type": "string",
                "description": "The mime-type of the attachment"
              },
              "preview_url": {
                "type": "string",
                "description": "A URL to a preview picture of the file"
              },
              "link_expires": {
                "type": "boolean",
                "default": false,
                "description": "If true, it will use the getMessageById endpoint for fetching updated attachment's urls. Find out more [here](https://pipedrive.readme.io/docs/implementing-messaging-app-extension)"
              }
            }
          },
          "description": "The list of attachments available in the message"
        },
        "conversation_id": {
          "type": "string",
          "description": "The ID of the conversation"
        },
        "conversation_link": {
          "type": "string",
          "format": "url",
          "description": "A URL that can open the conversation in the provider's side"
        }
      }
    },
    "success": {
      "type": "boolean",
      "description": "If the request was successful or not"
    }
  }
}

Load more schemas