diff --git a/CHANGELOG.md b/CHANGELOG.md index ff5ba862..68863a21 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19). ## [Unreleased] +### Fixed +- Removed `person_id` from the v2 activity request body (`POST /api/v2/activities`, `PATCH /api/v2/activities/{id}`) — the API has always rejected it as read-only, and the schema advertised it as writable; use `participants: [{ "person_id": 123, "primary": true }]` instead. `org_id` is unaffected. +- Added `required: [name]` to the v2 person create request body (`POST /api/v2/persons`) — a bare call previously reached the API instead of failing client-side. +- Reworded the `im`, `notes`, `birthday`, and `job_title` field descriptions and the `addPerson`/`updatePerson` operation descriptions (which also cover `postal_address`) to disclose that these fields 403 when contact sync isn't enabled, rather than only describing when they're present on read. ## [33.7.0] - 2026-09-08 ### Added diff --git a/src/versions/v1/api/legacy-teams-api.ts b/src/versions/v1/api/legacy-teams-api.ts index c7bd6e2b..485d086d 100644 --- a/src/versions/v1/api/legacy-teams-api.ts +++ b/src/versions/v1/api/legacy-teams-api.ts @@ -47,7 +47,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration?: Configu * Adds a new team to the company and returns the created object. * @summary Add a new team * @param {AddTeamRequest1} [AddTeamRequest1] - * @deprecated + * @throws {RequiredError} */ addTeam: async (AddTeamRequest1?: AddTeamRequest1, ): Promise => { @@ -89,7 +89,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration?: Configu * @summary Add users to a team * @param {number} id The ID of the team * @param {AddTeamUserRequest} [AddTeamUserRequest] - * @deprecated + * @throws {RequiredError} */ addTeamUser: async (id: number, AddTeamUserRequest?: AddTeamUserRequest, ): Promise => { @@ -134,7 +134,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration?: Configu * @summary Delete users from a team * @param {number} id The ID of the team * @param {DeleteTeamUserRequest} [DeleteTeamUserRequest] - * @deprecated + * @throws {RequiredError} */ deleteTeamUser: async (id: number, DeleteTeamUserRequest?: DeleteTeamUserRequest, ): Promise => { @@ -179,7 +179,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration?: Configu * @summary Get a single team * @param {number} id The ID of the team * @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users - * @deprecated + * @throws {RequiredError} */ getTeam: async (id: number, skip_users?: 0 | 1, ): Promise => { @@ -224,7 +224,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration?: Configu * Returns a list of all user IDs within a team. * @summary Get all users in a team * @param {number} id The ID of the team - * @deprecated + * @throws {RequiredError} */ getTeamUsers: async (id: number, ): Promise => { @@ -266,7 +266,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration?: Configu * @summary Get all teams * @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by * @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users - * @deprecated + * @throws {RequiredError} */ getTeams: async (order_by?: 'id' | 'name' | 'manager_id' | 'active_flag', skip_users?: 0 | 1, ): Promise => { @@ -314,7 +314,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration?: Configu * @param {number} id The ID of the user * @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by * @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users - * @deprecated + * @throws {RequiredError} */ getUserTeams: async (id: number, order_by?: 'id' | 'name' | 'manager_id' | 'active_flag', skip_users?: 0 | 1, ): Promise => { @@ -364,7 +364,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration?: Configu * @summary Update a team * @param {number} id The ID of the team * @param {UpdateTeamRequest} [UpdateTeamRequest] - * @deprecated + * @throws {RequiredError} */ updateTeam: async (id: number, UpdateTeamRequest?: UpdateTeamRequest, ): Promise => { @@ -419,7 +419,7 @@ export const LegacyTeamsApiFp = function(configuration?: Configuration) { * Adds a new team to the company and returns the created object. * @summary Add a new team * @param {AddTeamRequest1} [AddTeamRequest1] - * @deprecated + * @throws {RequiredError} */ async addTeam(AddTeamRequest1?: AddTeamRequest1, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -431,7 +431,7 @@ export const LegacyTeamsApiFp = function(configuration?: Configuration) { * @summary Add users to a team * @param {number} id The ID of the team * @param {AddTeamUserRequest} [AddTeamUserRequest] - * @deprecated + * @throws {RequiredError} */ async addTeamUser(id: number, AddTeamUserRequest?: AddTeamUserRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -443,7 +443,7 @@ export const LegacyTeamsApiFp = function(configuration?: Configuration) { * @summary Delete users from a team * @param {number} id The ID of the team * @param {DeleteTeamUserRequest} [DeleteTeamUserRequest] - * @deprecated + * @throws {RequiredError} */ async deleteTeamUser(id: number, DeleteTeamUserRequest?: DeleteTeamUserRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -455,7 +455,7 @@ export const LegacyTeamsApiFp = function(configuration?: Configuration) { * @summary Get a single team * @param {number} id The ID of the team * @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users - * @deprecated + * @throws {RequiredError} */ async getTeam(id: number, skip_users?: 0 | 1, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -466,7 +466,7 @@ export const LegacyTeamsApiFp = function(configuration?: Configuration) { * Returns a list of all user IDs within a team. * @summary Get all users in a team * @param {number} id The ID of the team - * @deprecated + * @throws {RequiredError} */ async getTeamUsers(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -478,7 +478,7 @@ export const LegacyTeamsApiFp = function(configuration?: Configuration) { * @summary Get all teams * @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by * @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users - * @deprecated + * @throws {RequiredError} */ async getTeams(order_by?: 'id' | 'name' | 'manager_id' | 'active_flag', skip_users?: 0 | 1, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -491,7 +491,7 @@ export const LegacyTeamsApiFp = function(configuration?: Configuration) { * @param {number} id The ID of the user * @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by * @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users - * @deprecated + * @throws {RequiredError} */ async getUserTeams(id: number, order_by?: 'id' | 'name' | 'manager_id' | 'active_flag', skip_users?: 0 | 1, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -503,7 +503,7 @@ export const LegacyTeamsApiFp = function(configuration?: Configuration) { * @summary Update a team * @param {number} id The ID of the team * @param {UpdateTeamRequest} [UpdateTeamRequest] - * @deprecated + * @throws {RequiredError} */ async updateTeam(id: number, UpdateTeamRequest?: UpdateTeamRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -524,7 +524,7 @@ export const LegacyTeamsApiFactory = function (configuration?: Configuration, ba * Adds a new team to the company and returns the created object. * @summary Add a new team * @param {LegacyTeamsApiAddTeamRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} */ addTeam(requestParameters: LegacyTeamsApiAddTeamRequest = {}, ): Promise { @@ -534,7 +534,7 @@ export const LegacyTeamsApiFactory = function (configuration?: Configuration, ba * Adds users to an existing team. * @summary Add users to a team * @param {LegacyTeamsApiAddTeamUserRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} */ addTeamUser(requestParameters: LegacyTeamsApiAddTeamUserRequest, ): Promise { @@ -544,7 +544,7 @@ export const LegacyTeamsApiFactory = function (configuration?: Configuration, ba * Deletes users from an existing team. * @summary Delete users from a team * @param {LegacyTeamsApiDeleteTeamUserRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} */ deleteTeamUser(requestParameters: LegacyTeamsApiDeleteTeamUserRequest, ): Promise { @@ -554,7 +554,7 @@ export const LegacyTeamsApiFactory = function (configuration?: Configuration, ba * Returns data about a specific team. * @summary Get a single team * @param {LegacyTeamsApiGetTeamRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} */ getTeam(requestParameters: LegacyTeamsApiGetTeamRequest, ): Promise { @@ -564,7 +564,7 @@ export const LegacyTeamsApiFactory = function (configuration?: Configuration, ba * Returns a list of all user IDs within a team. * @summary Get all users in a team * @param {LegacyTeamsApiGetTeamUsersRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} */ getTeamUsers(requestParameters: LegacyTeamsApiGetTeamUsersRequest, ): Promise { @@ -574,7 +574,7 @@ export const LegacyTeamsApiFactory = function (configuration?: Configuration, ba * Returns data about teams within the company. * @summary Get all teams * @param {LegacyTeamsApiGetTeamsRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} */ getTeams(requestParameters: LegacyTeamsApiGetTeamsRequest = {}, ): Promise { @@ -584,7 +584,7 @@ export const LegacyTeamsApiFactory = function (configuration?: Configuration, ba * Returns data about all teams which have the specified user as a member. * @summary Get all teams of a user * @param {LegacyTeamsApiGetUserTeamsRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} */ getUserTeams(requestParameters: LegacyTeamsApiGetUserTeamsRequest, ): Promise { @@ -594,7 +594,7 @@ export const LegacyTeamsApiFactory = function (configuration?: Configuration, ba * Updates an existing team and returns the updated object. * @summary Update a team * @param {LegacyTeamsApiUpdateTeamRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} */ updateTeam(requestParameters: LegacyTeamsApiUpdateTeamRequest, ): Promise { @@ -775,7 +775,7 @@ export class LegacyTeamsApi extends BaseAPI { * Adds a new team to the company and returns the created object. * @summary Add a new team * @param {LegacyTeamsApiAddTeamRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} * @memberof LegacyTeamsApi */ @@ -787,7 +787,7 @@ export class LegacyTeamsApi extends BaseAPI { * Adds users to an existing team. * @summary Add users to a team * @param {LegacyTeamsApiAddTeamUserRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} * @memberof LegacyTeamsApi */ @@ -799,7 +799,7 @@ export class LegacyTeamsApi extends BaseAPI { * Deletes users from an existing team. * @summary Delete users from a team * @param {LegacyTeamsApiDeleteTeamUserRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} * @memberof LegacyTeamsApi */ @@ -811,7 +811,7 @@ export class LegacyTeamsApi extends BaseAPI { * Returns data about a specific team. * @summary Get a single team * @param {LegacyTeamsApiGetTeamRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} * @memberof LegacyTeamsApi */ @@ -823,7 +823,7 @@ export class LegacyTeamsApi extends BaseAPI { * Returns a list of all user IDs within a team. * @summary Get all users in a team * @param {LegacyTeamsApiGetTeamUsersRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} * @memberof LegacyTeamsApi */ @@ -835,7 +835,7 @@ export class LegacyTeamsApi extends BaseAPI { * Returns data about teams within the company. * @summary Get all teams * @param {LegacyTeamsApiGetTeamsRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} * @memberof LegacyTeamsApi */ @@ -847,7 +847,7 @@ export class LegacyTeamsApi extends BaseAPI { * Returns data about all teams which have the specified user as a member. * @summary Get all teams of a user * @param {LegacyTeamsApiGetUserTeamsRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} * @memberof LegacyTeamsApi */ @@ -859,7 +859,7 @@ export class LegacyTeamsApi extends BaseAPI { * Updates an existing team and returns the updated object. * @summary Update a team * @param {LegacyTeamsApiUpdateTeamRequest} requestParameters Request parameters. - * @deprecated + * @throws {RequiredError} * @memberof LegacyTeamsApi */ diff --git a/src/versions/v2/api/deal-installments-api.ts b/src/versions/v2/api/deal-installments-api.ts index 2d6137a3..28405dbf 100644 --- a/src/versions/v2/api/deal-installments-api.ts +++ b/src/versions/v2/api/deal-installments-api.ts @@ -71,7 +71,7 @@ export const DealInstallmentsApiAxiosParamCreator = function (configuration?: Co // authentication oauth2 required // oauth required - await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration) + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full"], configuration) @@ -177,7 +177,7 @@ export const DealInstallmentsApiAxiosParamCreator = function (configuration?: Co // authentication oauth2 required // oauth required - await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration) + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full"], configuration) @@ -226,7 +226,7 @@ export const DealInstallmentsApiAxiosParamCreator = function (configuration?: Co // authentication oauth2 required // oauth required - await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration) + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full"], configuration) diff --git a/src/versions/v2/api/deals-api.ts b/src/versions/v2/api/deals-api.ts index d7a4c191..7e2f7139 100644 --- a/src/versions/v2/api/deals-api.ts +++ b/src/versions/v2/api/deals-api.ts @@ -226,7 +226,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration // authentication oauth2 required // oauth required - await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration) + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full"], configuration) @@ -847,7 +847,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration // authentication oauth2 required // oauth required - await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration) + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full"], configuration) @@ -980,7 +980,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration // authentication oauth2 required // oauth required - await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full"], configuration) + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["deals:full"], configuration) diff --git a/src/versions/v2/api/persons-api.ts b/src/versions/v2/api/persons-api.ts index f6520679..44d34ce8 100644 --- a/src/versions/v2/api/persons-api.ts +++ b/src/versions/v2/api/persons-api.ts @@ -52,7 +52,7 @@ import { UpsertPersonResponse } from '../models'; export const PersonsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Adds a new person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync. + * Adds a new person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403. * @summary Add a new person * @param {AddPersonRequest} [AddPersonRequest] @@ -614,7 +614,7 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Updates the properties of a person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync. + * Updates the properties of a person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403. * @summary Update a person * @param {number} id The ID of the person * @param {UpdatePersonRequest} [UpdatePersonRequest] @@ -670,7 +670,7 @@ export const PersonsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PersonsApiAxiosParamCreator(configuration) return { /** - * Adds a new person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync. + * Adds a new person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403. * @summary Add a new person * @param {AddPersonRequest} [AddPersonRequest] @@ -810,7 +810,7 @@ export const PersonsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Updates the properties of a person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync. + * Updates the properties of a person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403. * @summary Update a person * @param {number} id The ID of the person * @param {UpdatePersonRequest} [UpdatePersonRequest] @@ -832,7 +832,7 @@ export const PersonsApiFactory = function (configuration?: Configuration, basePa const localVarFp = PersonsApiFp(configuration) return { /** - * Adds a new person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync. + * Adds a new person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403. * @summary Add a new person * @param {PersonsApiAddPersonRequest} requestParameters Request parameters. @@ -932,7 +932,7 @@ export const PersonsApiFactory = function (configuration?: Configuration, basePa return localVarFp.searchPersons(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor, ).then((request) => request(axios, basePath)); }, /** - * Updates the properties of a person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync. + * Updates the properties of a person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403. * @summary Update a person * @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters. @@ -1323,7 +1323,7 @@ export interface PersonsApiUpdatePersonRequest { */ export class PersonsApi extends BaseAPI { /** - * Adds a new person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync. + * Adds a new person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403. * @summary Add a new person * @param {PersonsApiAddPersonRequest} requestParameters Request parameters. @@ -1443,7 +1443,7 @@ export class PersonsApi extends BaseAPI { } /** - * Updates the properties of a person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync. + * Updates the properties of a person.
If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403. * @summary Update a person * @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters. diff --git a/src/versions/v2/models/add-activity-request.ts b/src/versions/v2/models/add-activity-request.ts index 80a74bf1..76ac0ec0 100644 --- a/src/versions/v2/models/add-activity-request.ts +++ b/src/versions/v2/models/add-activity-request.ts @@ -55,11 +55,6 @@ export interface AddActivityRequest { */ 'lead_id'?: string; /** - * The ID of the person linked to the activity - * @type {number} - */ - 'person_id'?: number; - /** * The ID of the organization linked to the activity * @type {number} */ @@ -100,7 +95,7 @@ export interface AddActivityRequest { */ 'location'?: AddActivityRequestLocation; /** - * The participants of the activity + * The participants of the activity. Use this to set the activity\'s person — a primary participant (`primary: true`) sets `person_id` on the activity. * @type {Array} */ 'participants'?: Array; diff --git a/src/versions/v2/models/add-person-request.ts b/src/versions/v2/models/add-person-request.ts index 4a7afe63..df8f7cd5 100644 --- a/src/versions/v2/models/add-person-request.ts +++ b/src/versions/v2/models/add-person-request.ts @@ -36,7 +36,7 @@ export interface AddPersonRequest { * The name of the person * @type {string} */ - 'name'?: string; + 'name': string; /** * The ID of the user who owns the person * @type {number} @@ -78,22 +78,22 @@ export interface AddPersonRequest { */ 'postal_address'?: PersonItemAddress; /** - * Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company + * Contact sync notes of the person, maximum 10 000 characters. Only accepted when contact sync is enabled for the company; otherwise the request returns 403. * @type {string} */ 'notes'?: string; /** - * The instant messaging accounts of the person, included if contact sync is enabled for the company + * The instant messaging accounts of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403. * @type {Array} */ 'im'?: Array; /** - * The birthday of the person, included if contact sync is enabled for the company + * The birthday of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403. * @type {string} */ 'birthday'?: string; /** - * The job title of the person, included if contact sync is enabled for the company + * The job title of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403. * @type {string} */ 'job_title'?: string; diff --git a/src/versions/v2/models/update-person-request.ts b/src/versions/v2/models/update-person-request.ts index 80ea5643..24dc17fa 100644 --- a/src/versions/v2/models/update-person-request.ts +++ b/src/versions/v2/models/update-person-request.ts @@ -73,22 +73,22 @@ export interface UpdatePersonRequest { */ 'postal_address'?: PersonItemAddress; /** - * Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company + * Contact sync notes of the person, maximum 10 000 characters. Only accepted when contact sync is enabled for the company; otherwise the request returns 403. * @type {string} */ 'notes'?: string; /** - * The instant messaging accounts of the person, included if contact sync is enabled for the company + * The instant messaging accounts of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403. * @type {Array} */ 'im'?: Array; /** - * The birthday of the person, included if contact sync is enabled for the company + * The birthday of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403. * @type {string} */ 'birthday'?: string; /** - * The job title of the person, included if contact sync is enabled for the company + * The job title of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403. * @type {string} */ 'job_title'?: string;