COcoevera
Contact

Create a contact

Creates one contact and answers 201 with the record. owner_id and a first_name or last_name are required; the spec marks only owner_id.

post/entities/Contacts

Request

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

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

addressstring

Street address of the contact.

citystring

City of the contact address.

commentsstring

Free-form notes describing the contact.

contact_type_idstring uuid

Id of the contact type assigned to this contact.

countrystring

Country of the contact address.

currency_exchange_rates_list_idstring uuid

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

email1string

Primary email address of the contact. 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.

first_namestring

Given name of the contact.

gender0 | 1 | 2 | 3

Gender of the contact: Unknown when not specified, Male, Female or NonBinary.

Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary

is_archivedboolean

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

last_namestring

Family name of the contact.

middle_namestring

Middle name of the contact, if applicable.

owner_idstring uuid required

Id of the contact owner.

phone1string

Primary phone number of the contact. 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.

positionstring

Job title or position of the contact.

quick_account_namestring

Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate 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 contact address.

titlestring

Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name.

unit_idstring uuid

Id of the sales unit.

zip_codestring

ZIP or postal code of the contact address.

revisioninteger

Revision when entity was lastly changed.

account_positionstring

Job position of Contact in his primary Account or quick account position if Contact has no primary Account.

is_unsubscribedboolean

If account has any unsubscribed email.

primary_account_relationshipstring

Org chart relationship of Contact in his primary Account.

Example request

{
  "modified": "2019-01-01T00:00:00",
  "created": "2019-01-01T00:00:00",
  "address": "string",
  "city": "string",
  "comments": "string",
  "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "country": "string",
  "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
  "email1": "string",
  "email2": "string",
  "email3": "string",
  "email4": "string",
  "email5": "string",
  "first_name": "string",
  "last_name": "string",
  "middle_name": "string",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "phone1": "string",
  "phone2": "string",
  "phone3": "string",
  "phone4": "string",
  "phone5": "string",
  "picture_id": "01234567-abcd-dcba-ffff-000000000000",
  "position": "string",
  "quick_account_name": "string",
  "state_province": "string",
  "title": "string",
  "unit_id": "01234567-abcd-dcba-ffff-000000000000",
  "zip_code": "string",
  "revision": 1,
  "account_position": "string",
  "primary_account_relationship": "string"
}

Response

The created Contact 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",
    "address": "string",
    "city": "string",
    "comments": "string",
    "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "country": "string",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "email1": "string",
    "email2": "string",
    "email3": "string",
    "email4": "string",
    "email5": "string",
    "first_name": "string",
    "last_name": "string",
    "middle_name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "phone1": "string",
    "phone2": "string",
    "phone3": "string",
    "phone4": "string",
    "phone5": "string",
    "picture_id": "01234567-abcd-dcba-ffff-000000000000",
    "position": "string",
    "quick_account_name": "string",
    "state_province": "string",
    "title": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "zip_code": "string",
    "revision": 1,
    "formatted_name": "string",
    "exchange_entity_id": "string",
    "gapi_entity_id": "string",
    "o365_entity_id": "string",
    "primary_account_position": "string",
    "account_position": "string",
    "primary_account_relationship": "string",
    "modified_by_user": "2019-01-01T00:00:00"
  }
}

Changes

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