Skip to main content

Upsert an account

POST 
/v2/account_upserts

Upserts an account record. The upsert_key dictates how the upsert will be performed. The create and update behavior is exactly the same as the individual create and update endpoints.

Request​

Body

required
    upsert_key string

    Name of the parameter to upsert on. The field must be provided in the input parameters, or the request will fail. The request will also fail if there are multiple records matched by the upsert field.

    If upsert_key is not provided, this endpoint will not update an existing record.

    Valid options are: id, crm_id, domain. If crm_id is provided, then a valid crm_id_type must be provided, as documented for the account create and update endpoints.

    id integer

    ID of the account to update. Used if the upsert_key=id. When id and another upsert_key are provided, the request will fail if the upsert record id and id parameter don't match.

    name string

    Account Full Name

    domain string

    Website domain, not a fully qualified URI

    conversational_name string

    Conversational name of the Account

    description string

    Description

    phone string

    Phone number without formatting

    website string

    Website

    linkedin_url string

    Full LinkedIn url

    twitter_handle string

    Twitter handle, with @

    street string

    Street name and number

    city string

    City

    state string

    State

    postal_code string

    Postal code

    country string

    Country

    locale string

    Time locale

    industry string

    Industry

    company_type string

    Type of the Account's company

    founded string

    Date or year of founding

    revenue_range string

    Estimated revenue range

    size string

    Estimated number of people in employment

    do_not_contact boolean

    Whether this company can not be contacted. Values are either true or false. Setting this to true will remove all associated people from all active communications

    custom_fields object[]

    Custom fields are defined by the user's team. Only fields with values are presented in the API.

    tags string[]

    All tags applied to this Account

    owner_id integer

    ID of the User that owns this Account

    company_stage_id integer

    ID of the CompanyStage assigned to this Account

    account_tier_id integer

    ID of the Account Tier for this Account

    crm_id_type string

    The CRM that the provided crm_id is for. Must be one of: salesforce

    crm_id string

    Requires Salesforce.

    ID of the person in your external CRM. You must provide a crm_id_type if this is included.

    Validations will be applied to the crm_id depending on the crm_id_type. A "salesforce" ID must be exactly 18 characters. A "salesforce" ID must be either an Account (001) object. The type will be validated using the 18 character ID.

    This field can only be used if your application or API key has the "account:set_crm_id" scope.

Responses​

Success

Schema
    upsert_type string

    The type of upsert. One of: create, update

    account object
    id integer

    ID of Account

    created_at date-time

    Datetime of when the Account was created

    updated_at date-time

    Datetime of when the Account was last updated

    archived_at date-time

    Datetime of when the Account was archived, if archived

    name string

    Account Full Name

    domain string

    Website domain, not a fully qualified URI

    conversational_name string

    Conversational name of the Account

    description string

    Description

    phone string

    Phone number without formatting

    website string

    Website

    linkedin_url string

    Full LinkedIn url

    twitter_handle string

    Twitter handle, with @

    street string

    Street name and number

    city string

    City

    state string

    State

    postal_code string

    Postal code

    country string

    Country

    locale string

    Time locale

    industry string

    Industry

    company_type string

    Type of the Account's company

    founded string

    Date or year of founding

    revenue_range string

    Estimated revenue range

    size string

    Estimated number of people in employment

    crm_id string

    CRM ID

    crm_url string

    CRM url

    crm_object_type string

    CRM object type

    owner_crm_id string

    Mapped owner field from the CRM

    last_contacted_at date-time

    Datetime this Account was last contacted

    last_contacted_type string

    The type of the last touch to this Account. Can be call, email, other

    do_not_contact boolean

    Whether this company has opted out of communications. Do not contact someone at this company when this is set to true

    custom_fields object

    Custom fields are defined by the user's team. Only fields with values are presented in the API.

    user_relationships object

    Filters by accounts matching all given user relationship fields, _is_null or _unmapped can be passed to filter accounts with null or unmapped user relationship values

    tags string[]

    All tags applied to this Account

    counts object
    people integer

    Number of people in SalesLoft associated with this Account

    owner object

    User that is marked as the owner of this Account

    id integer
    _href string
    creator object

    User that created this Account

    id integer
    _href string
    last_contacted_by object

    User that last contacted this Account

    id integer
    _href string
    last_contacted_person object

    Person who was last contacted at this Account

    id integer
    _href string
    company_stage object

    Company Stage that this Account has set. This is referred to as Account Stage in other parts of the API. When sorting by account_stage, the company stage's order is used

    id integer
    _href string
    account_tier object

    Account Tier that this Account has set

    id integer
    _href string
Loading...