Skip to main content

update contact

PATCH 
/org/:orgId/contact/:contactId

Update the contact for the given organization and contact ID. This endpoint supports partial updates. Only the fields provided in the request body will be updated. To clear a field, provide it with an empty value.

Request​

Path Parameters

    orgId stringrequired

    Organization ID

    contactId stringrequired

    Contact ID

Body

required

Request Body

    companyContactId string
    creationTime string
    emailAddress string
    id string

    This is generated by Suger. When you create a new contact, do not provide.

    info

    object

    companyLocation string
    companyName string

    enrichedContactInfo

    object

    city string
    companyDomain string
    companyName string

    Company information

    country string

    Location information

    creationTime string

    Timestamps

    email string

    Contact information

    firstName string
    id string

    Core identification fields

    info

    object

    Additional structured information

    workExperiences

    object[]

  • Array [

    • current boolean

    true if the work experience is current

    endDate string
    organizationName string
    startDate string
    title string

  • ]

    • jobFunction string
    jobTitle string

    Professional information

    lastName string
    lastUpdateTime string
    linkedIn string
    name string
    phone string
    s3KeyPicture string

    Media and social

    status EnrichmentDataStatus (string)

    Possible values: [active, stale, archived]

    active/stale/archived

    twitter string
    lastModifiedBy string
    partner Partner (string)

    Possible values: [``, ADYEN, ALIBABA, ANTHROPIC, AWS, AWS_CHINA, AZURE, CHARGEBEE, DATABRICKS, DOCUSIGN, GCP, GOOGLE, HUBSPOT, INTUIT, LAGO, MARKETO, METRONOME, MICROSOFT, OPENAI, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, SNOWFLAKE, STRIPE, ZOHO]

    phoneNumber string
    role string
    lastUpdateTime string
    name string
    organizationID string

Responses​

OK

Schema

    companyContactId string
    creationTime string
    emailAddress string
    id string

    This is generated by Suger. When you create a new contact, do not provide.

    info

    object

    companyLocation string
    companyName string

    enrichedContactInfo

    object

    city string
    companyDomain string
    companyName string

    Company information

    country string

    Location information

    creationTime string

    Timestamps

    email string

    Contact information

    firstName string
    id string

    Core identification fields

    info

    object

    Additional structured information

    workExperiences

    object[]

  • Array [

    • current boolean

    true if the work experience is current

    endDate string
    organizationName string
    startDate string
    title string

  • ]

    • jobFunction string
    jobTitle string

    Professional information

    lastName string
    lastUpdateTime string
    linkedIn string
    name string
    phone string
    s3KeyPicture string

    Media and social

    status EnrichmentDataStatus (string)

    Possible values: [active, stale, archived]

    active/stale/archived

    twitter string
    lastModifiedBy string
    partner Partner (string)

    Possible values: [``, ADYEN, ALIBABA, ANTHROPIC, AWS, AWS_CHINA, AZURE, CHARGEBEE, DATABRICKS, DOCUSIGN, GCP, GOOGLE, HUBSPOT, INTUIT, LAGO, MARKETO, METRONOME, MICROSOFT, OPENAI, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, SNOWFLAKE, STRIPE, ZOHO]

    phoneNumber string
    role string
    lastUpdateTime string
    name string
    organizationID string
Loading...