Create Object
commonroom_create_objectFull Description
Creates a new object in Common Room.
Supported object types:
- Contact: Creates or updates a contact. Provide "email" and "fullName", or pass a "prospectorContactId" to create from a ProspectorContact (the API will resolve prospect data automatically). Optionally set custom fields via "customFields" array.
- Segment: Creates a new static segment. Requires "name". Optional "entityType" ("contact" or "organization", defaults to "contact").
- Activity: Creates a timestamped activity on a contact. Requires "contactId", "activityType" (see schema enum), "activityBody". Use commonroom_list_objects with objectType "ActivityType" to discover valid activityType values.
- Note: Creates a text note on a contact profile. Requires "contactId", "note".
- Organization: Creates or updates an organization. Provide "domain", or pass a "prospectorCompanyId" to create from a ProspectorCompany (the API will resolve prospect data automatically). Optional "name".
Use commonroom_list_objects to look up contact emails, segment IDs (s_-prefixed), and custom field IDs (cf_-prefixed).
Parameters (1 required, 22 optional)
objectTypestringThe type of object to create.
ContactSegmentActivityNoteOrganizationactivityBodystringactivityTypestringUserInputAcceptedMeetingAddedUserInputActivityFeatureIdeaAddedUserInputAnsweredCallAddedUserInputAnsweredFormSurveyAddedUserInputAppliedChampionProgramAddedUserInputArticleAddedUserInputAttendedDemoAddedUserInputAttendedGatheringAddedUserInputAttendedMeetingAddedUserInputAttendedProductDiscoveryCallAddedUserInputAttendedRoadmapCallAddedUserInputAttendedWebinarAddedUserInputBookedMeetingAddedUserInputCalledInAddedUserInputCommentedRepliedAddedUserInputCommentedTicketAddedUserInputCompletedOnboardingAddedUserInputCompletedTrainingAddedUserInputCompletedTransactionAddedUserInputCreatedAnAccountAddedUserInputCreatedTicketAddedUserInputCreatedTrainingMaterialAddedUserInputDealClosedAddedUserInputDealCreatedAddedUserInputDeclinedRewardAddedUserInputEligibleRewardAddedUserInputEnrolledInChampionProgramAddedUserInputEnrolledInTrainingAddedUserInputGraduatedFromChampionProgramAddedUserInputHostedGatheringAddedUserInputHostedMeetingAddedUserInputHostedWebinarAddedUserInputIdentifiedPowerUserAddedApiUserImportedUserInputJoinedUserInputJoinedAdvisoryBoardAddedUserInputJoinedGroupAddedUserInputLikedReactedAddedUserInputLinkAddedUserInputLoggedInAddedUserInputMadeCommitAddedUserInputMadeMergeRequestAddedUserInputMadePostTopicAddedUserInputMadeReferralAddedUserInputMergeRequestMergedUserInputOtherAddedUserInputParticipatedEarlyAccessProgramAddedUserInputPresentedAtGatheringAddedUserInputPresentedAtWebinarAddedUserInputProvidedCaseStudyAddedUserInputProvidedProductFeedbackAddedUserInputReceivedAMessageAddedUserInputReceivedCallNoAnswerAddedUserInputReceivedEmailAddedUserInputReceivedFormSurveyAddedUserInputReceivedGiftAddedUserInputReceivedLiMessageAddedUserInputReceivedSmsAddedUserInputReceivedTagBadgeAddedUserInputReceivedWhatsappAddedUserInputRedeemedRewardAddedUserInputRegisteredForGatheringAddedUserInputRegisteredForWebinarAddedUserInputRegisteredSpeakerForGatheringAddedUserInputRequestedDemoAddedUserInputRequestedEarlyAccessProgramAddedUserInputSentAMessageAddedUserInputSentEmailAddedUserInputSentGiftAddedUserInputSentLiMessageAddedUserInputSentSmsAddedUserInputSentWhatsappAddedUserInputSignedUpForProductAddedUserInputSignedUpForTrialAddedUserInputStartedGroupChatAddedUserInputStartedSessionUserInputStartedTrainingAddedUserInputStickerOrderAddedUserInputStickerReceivedAddedUserInputStickerRequestAddedUserInputSubmittedFeatureRequestAddedUserInputSubmittedFormAddedUserInputSubmittedIdeaAddedUserInputSubscribedNewsletterAddedUserInputSwagOrderAddedUserInputSwagReceivedAddedUserInputSwagRequestAddedUserInputTaggedInMediaAddedUserInputUpdatedTicketAddedUserInputUploadedPhotoAddedUserInputUploadedVideoAddedUserInputViewedPageAddedcommunityIdstringOptional community ID to scope this request. Overrides the default community context.
companyDomainstringOrganization domain to link the contact to (e.g. "acme.com"). Creates the org if it doesn't exist.
companyNamestringcontactIdstringContact ID (c_-prefixed). Required when objectType is "Activity" or "Note".
customFieldsarrayCustom fields to set on the contact or organization.
descriptionstringdomainstringCompany domain
emailstringEmail address (used as dedup key)
entityTypestringEntity type for the segment: "contact" (default) or "organization". Determines what kind of records the segment contains.
contactorganizationfullNamestringFull name
githubUsernamestringlinkedInUrlstringnamestringSegment name (when objectType is "Segment") or organization name (when objectType is "Organization").
notestringoccurredAtstringprospectorCompanyIdstringID of a ProspectorCompany to create from. When provided, the API will auto-populate organization fields from the prospect company.
prospectorContactIdstringID of a ProspectorContact to create from. When provided, the API will auto-populate contact fields from the prospect.
segmentIdstringSegment ID to assign the contact to (e.g. s_123). Use commonroom_list_objects with objectType "Segment" to find segment IDs.
titlestringtwitterHandlestring