COcoevera
Account

Update an account

Changes the fields you send and leaves the rest as they are; there is no PUT. An id in the body that differs from the one in the URL is refused with code 2002.

patch/entities/Accounts/{id}

Request

Path parameters

idstring uuid required

Id of the Account record to update.

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

createdstring date-time

Creation time.

account_class1 | 2 | 3 | 4 | 5

Manual classification grade assigned to the account. Used in segmentation and reporting.

Integer enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD

account_type_idstring uuid

Id of the account type assigned to this account.

addressstring

Street address of the account.

citystring

City of the account address.

commentsstring

Free-form notes describing the account.

countrystring

Country of the account address.

currency_exchange_rates_list_idstring uuid

Id of the currency exchange rate list applied to this account.

customer_type_idstring uuid

Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account.

email1string

Primary email address of the account. Used as default recipient for emails sent from Coevera.

email2string

Additional email address.

email3string

Additional email address.

email4string

Additional email address.

email5string

Additional email address.

home_pagestring

Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled.

industry_idstring uuid

Id of the industry classification.

is_archivedboolean

True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated.

last_ai_account_hierarchy_appliedstring date-time

Time when an AI-suggested account hierarchy was last applied to this account.

last_ai_org_chart_appliedstring date-time

Time when an AI-suggested org chart was last applied to this account.

namestring

Name of the entity and its default text representation.

owner_idstring uuid

Id of the account owner.

parent_account_idstring uuid

Id of the parent account in the corporate hierarchy. Empty for top-level accounts.

parent_account_relation_type_idstring uuid

Id of the parent-account relationship type.

phone1string

Primary phone number of the account. Used as default target for click-to-call.

phone2string

Additional phone number.

phone3string

Additional phone number.

phone4string

Additional phone number.

phone5string

Additional phone number.

picture_idstring uuid

Id of the profile picture document.

quick_parent_account_namestring

Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account.

share_mode0 | 1 | 2 | 3

Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

state_provincestring

State or province of the account address.

unit_idstring uuid

Id of the sales unit.

zip_codestring

ZIP or postal code of the account address.

revisioninteger

Revision when entity was lastly changed.

is_unsubscribedboolean

If account has any unsubscribed email.

Example request

{
  "created": "2019-01-01T00:00:00",
  "account_class": 1,
  "account_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "address": "string",
  "city": "string",
  "comments": "string",
  "country": "string",
  "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
  "customer_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "email1": "string",
  "email2": "string",
  "email3": "string",
  "email4": "string",
  "email5": "string",
  "home_page": "string",
  "industry_id": "01234567-abcd-dcba-ffff-000000000000",
  "last_ai_account_hierarchy_applied": "2019-01-01T00:00:00",
  "last_ai_org_chart_applied": "2019-01-01T00:00:00",
  "name": "string",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "parent_account_id": "01234567-abcd-dcba-ffff-000000000000",
  "parent_account_relation_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "phone1": "string",
  "phone2": "string",
  "phone3": "string",
  "phone4": "string",
  "phone5": "string",
  "picture_id": "01234567-abcd-dcba-ffff-000000000000",
  "quick_parent_account_name": "string",
  "state_province": "string",
  "unit_id": "01234567-abcd-dcba-ffff-000000000000",
  "zip_code": "string",
  "revision": 1
}

Response

The changed Account record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "account_class": 1,
    "account_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "address": "string",
    "city": "string",
    "comments": "string",
    "country": "string",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "customer_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "email1": "string",
    "email2": "string",
    "email3": "string",
    "email4": "string",
    "email5": "string",
    "health_category": "01234567-abcd-dcba-ffff-000000000000",
    "health_status": 1,
    "home_page": "string",
    "industry_id": "01234567-abcd-dcba-ffff-000000000000",
    "last_ai_account_hierarchy_applied": "2019-01-01T00:00:00",
    "last_ai_org_chart_applied": "2019-01-01T00:00:00",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "parent_account_id": "01234567-abcd-dcba-ffff-000000000000",
    "parent_account_relation_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "phone1": "string",
    "phone2": "string",
    "phone3": "string",
    "phone4": "string",
    "phone5": "string",
    "picture_id": "01234567-abcd-dcba-ffff-000000000000",
    "quick_parent_account_name": "string",
    "state_province": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "zip_code": "string",
    "revision": 1,
    "formatted_name": "string",
    "modified_by_user": "2019-01-01T00:00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.