v1

latestOpenAPI 3.0.3Apache 2.02026-07-1352108391.8 KB

Contacts

Update contact

patch/crm/contacts/{id}

Path parameters

idstring required

ID of the record you are acting upon.

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Request body

idstring

Unique identifier for the contact.

namestring nullable

Full name of the contact.

owner_idstring nullable

The owner of the contact.

type'customer' | 'supplier' | 'employee' | 'personal' nullable

The type of the contact.

company_idstring nullable

The company the contact is associated with.

company_namestring nullable

The name of the company the contact is associated with.

lead_idstring nullable

The lead the contact is associated with.

first_namestring nullable

The first name of the contact.

middle_namestring nullable

The middle name of the contact.

last_namestring nullable

The last name of the contact.

prefixstring nullable

The prefix of the contact.

suffixstring nullable

The suffix of the contact.

titlestring nullable

The job title of the contact.

departmentstring nullable

The department of the contact.

languagestring nullable

language code according to ISO 639-1. For the United States - EN

gender'male' | 'female' | 'unisex' nullable

The gender of the contact.

birthdaystring nullable

The birthday of the contact.

imagestring nullable

photo_urlstring nullable

The URL of the photo of a person.

lead_sourcestring nullable

The lead source of the contact.

faxstring nullable

The fax number of the contact.

descriptionstring nullable

The description of the contact.

current_balancenumber nullable

The current balance of the contact.

statusstring nullable

The status of the contact.

activeboolean nullable

The active status of the contact.

email_domainstring nullable

tagsstring[] nullable

first_call_atstring date-time nullable

The first call date of the contact.

first_email_atstring date-time nullable

The first email date of the contact.

last_activity_atstring date-time nullable

The last activity date of the contact.

custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

updated_atstring date-time nullable

The last update date of the contact.

created_atstring date-time nullable

The creation date of the contact.

opportunity_idsstring[]

The opportunity ids of the contact.

Example request

{
  "id": "12345",
  "name": "Elon Musk",
  "owner_id": "54321",
  "type": "personal",
  "company_id": "23456",
  "company_name": "23456",
  "lead_id": "34567",
  "first_name": "Elon",
  "middle_name": "D.",
  "last_name": "Musk",
  "prefix": "Mr.",
  "suffix": "PhD",
  "title": "CEO",
  "department": "Engineering",
  "language": "EN",
  "gender": "female",
  "birthday": "2000-08-12",
  "image": "https://unavatar.io/elon-musk",
  "photo_url": "https://unavatar.io/elon-musk",
  "lead_source": "Cold Call",
  "fax": "+12129876543",
  "description": "Internal champion",
  "current_balance": 10.5,
  "status": "open",
  "active": true,
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "line5": "Attention: Finance Dept",
      "street_number": "25",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638",
      "county": "Santa Clara",
      "contact_name": "Elon Musk",
      "salutation": "Mr",
      "phone_number": "111-111-1111",
      "fax": "122-111-1111",
      "email": "elon@musk.com",
      "website": "https://elonmusk.com",
      "notes": "Address notes or delivery instructions.",
      "row_version": "1-12345"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck",
      "type": "twitter"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "country_code": "1",
      "area_code": "323",
      "number": "111-111-1111",
      "extension": "105",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "email_domain": "gmail.com",
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "tags": [
    "New"
  ],
  "first_call_at": "2020-09-30T07:43:32.000Z",
  "first_email_at": "2020-09-30T07:43:32.000Z",
  "last_activity_at": "2020-09-30T07:43:32.000Z",
  "updated_at": "2017-08-12T20:43:21.291Z",
  "created_at": "2017-08-12T20:43:21.291Z",
  "opportunity_ids": [
    "12345"
  ],
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

Contact updated

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "contacts",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}