Back to Pipedrive OauthAdd an organization
Adds a new organization. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the organizationFields and look for key
values. For more information, see the tutorial for adding an organization.
Input
type: object
properties:
data:
title: addOrganizationRequest
type: object
required:
- name
properties:
name:
type: string
description: The name of the organization
add_time:
type: string
description: >-
The optional creation date & time of the organization in UTC. Requires
admin user API token. Format: YYYY-MM-DD HH:MM:SS
owner_id:
type: integer
description: >-
The ID of the user who will be marked as the owner of this
organization. When omitted, the authorized user ID will be used.
visible_to:
type: string
description: >-
The visibility of the organization. If omitted, the visibility will be
set to the default visibility setting of this item type for the
authorized user. Read more about visibility groups <a
href="https://support.pipedrive.com/en/article/visibility-groups"
target="_blank" rel="noopener noreferrer">here</a>.<h4>Essential /
Advanced plan</h4><table><tr><th
style="width:40px">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner
& followers</td><tr><td>`3`</td><td>Entire
company</td></tr></table><h4>Professional / Enterprise
plan</h4><table><tr><th
style="width:40px">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner
only</td><tr><td>`3`</td><td>Owner's visibility
group</td></tr><tr><td>`5`</td><td>Owner's visibility group and
sub-groups</td></tr><tr><td>`7`</td><td>Entire
company</td></tr></table>
enum:
- '1'
- '3'
- '5'
- '7'
Output
title: addOrganizationResponse200
type: object
properties:
success:
type: boolean
description: If the response is successful or not
data:
title: baseOrganizationItemWithEditNameFlag
type: object
properties:
id:
type: integer
description: The ID of the organization
company_id:
type: integer
description: The ID of the company related to the organization
owner_id:
title: owner
type: object
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
value:
type: integer
description: The ID of the owner
name:
type: string
description: The name of the organization
active_flag:
type: boolean
description: Whether the organization is active or not
picture_id:
type: object
properties:
value:
type: integer
description: The ID of the picture associated with the item
item_type:
type: string
description: The type of item the picture is related to
item_id:
type: integer
description: The ID of related item
active_flag:
type: boolean
description: Whether the associated picture is active or not
add_time:
type: string
description: The add time of the picture
update_time:
type: string
description: The update time of the picture
added_by_user_id:
type: integer
description: The ID of the user who added the picture
pictures:
type: object
properties:
'128':
type: string
description: The URL of the 128*128 picture
'512':
type: string
description: The URL of the 512*512 picture
country_code:
type: string
description: The country code of the organization
first_char:
type: string
description: The first character of the organization name
add_time:
type: string
description: The creation date and time of the organization
update_time:
type: string
description: The last updated date and time of the organization
visible_to:
type: string
description: The visibility group ID of who can see the organization
label:
type: integer
description: The ID of the label
owner_name:
type: string
description: The name of the organization owner
cc_email:
type: string
description: The BCC email of the organization
email_messages_count:
type: integer
description: The count of email messages related to the organization
people_count:
type: integer
description: The count of persons related to the organization
activities_count:
type: integer
description: The count of activities related to the organization
done_activities_count:
type: integer
description: The count of done activities related to the organization
undone_activities_count:
type: integer
description: The count of undone activities related to the organization
files_count:
type: integer
description: The count of files related to the organization
notes_count:
type: integer
description: The count of notes related to the organization
followers_count:
type: integer
description: The count of followers related to the organization
address:
type: string
description: The full address of the organization
address_subpremise:
type: string
description: The sub-premise of the organization location
address_street_number:
type: string
description: The street number of the organization location
address_route:
type: string
description: The route of the organization location
address_sublocality:
type: string
description: The sub-locality of the organization location
address_locality:
type: string
description: The locality of the organization location
address_admin_area_level_1:
type: string
description: The level 1 admin area of the organization location
address_admin_area_level_2:
type: string
description: The level 2 admin area of the organization location
address_country:
type: string
description: The country of the organization location
address_postal_code:
type: string
description: The postal code of the organization location
address_formatted_address:
type: string
description: The formatted organization location
open_deals_count:
type: integer
description: The count of open deals related with the item
related_open_deals_count:
type: integer
description: The count of related open deals related with the item
closed_deals_count:
type: integer
description: The count of closed deals related with the item
related_closed_deals_count:
type: integer
description: The count of related closed deals related with the item
won_deals_count:
type: integer
description: The count of won deals related with the item
related_won_deals_count:
type: integer
description: The count of related won deals related with the item
lost_deals_count:
type: integer
description: The count of lost deals related with the item
related_lost_deals_count:
type: integer
description: The count of related lost deals related with the item
next_activity_date:
type: string
description: The date of the next activity associated with the deal
next_activity_time:
type: string
description: The time of the next activity associated with the deal
next_activity_id:
type: integer
nullable: true
description: The ID of the next activity associated with the deal
last_activity_id:
type: integer
nullable: true
description: The ID of the last activity associated with the deal
last_activity_date:
type: string
nullable: true
description: The date of the last activity associated with the deal
edit_name:
type: boolean
description: >-
If the company ID of the organization and company ID of the request is
same or not
related_objects:
type: object
properties:
organization:
type: object
properties:
ORGANIZATION_ID:
type: object
description: The ID of the organization associated with the item
properties:
id:
type: integer
description: The ID of the organization associated with the item
name:
type: string
description: The name of the organization associated with the item
people_count:
type: integer
description: >-
The number of people connected with the organization that is
associated with the item
owner_id:
type: integer
description: >-
The ID of the owner of the organization that is 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
user:
type: object
properties:
USER_ID:
type: object
title: userDataWithId
description: The ID of the user
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
picture:
type: object
description: The picture that is associated with the item
properties:
PICTURE_ID:
type: object
description: The ID of the picture
properties:
id:
type: integer
description: The ID of the picture associated with the item
item_type:
type: string
description: The type of item the picture is related to
item_id:
type: integer
description: The ID of related item
active_flag:
type: boolean
description: Whether the associated picture is active or not
add_time:
type: string
description: The add time of the picture
update_time:
type: string
description: The update time of the picture
added_by_user_id:
type: integer
description: The ID of the user who added the picture
pictures:
type: object
properties:
'128':
type: string
description: The URL of the 128*128 picture
'512':
type: string
description: The URL of the 512*512 picture