Contact

patch

https://api.marketcircle.net/v1/contacts/{id}

Modify an existing contact

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This function allows you to modify an existing contact. See Contact for a list of attributes which are supported for contacts. Only attributes marked as Read-Write can be modified using this endpoint.

📘
Note
When editing a contact, including the add or remove actions will allow you to specify a list of items to update/remove from the field's existing contents. Leaving out add or remove will replace the fields contents entirely.
Examples:
{ "keywords": { "add":["test"] } }
{ "keywords": { "remove":["test"] } }

A successful update returns 204 No Content with an empty body. Attributes you leave out are not changed.

🚧
Contacts in the trash
A contact in the trash can't be edited; the request returns 404 with {"error":"trashed_object"}. To restore it, send {"trashed": false}. You can include other changes in the same request.

Path Params

int32

required

The contact ID

Body Params

prefix

string

Salutation, e.g. "Mr." or "Dr." (max 128 characters).

individual_salutation

string

How to address the contact in letters, e.g. "Dear John" (max 512 characters).

first_name

string

First name (max 256 characters).

middle_name

string

Middle name(s) (max 256 characters).

last_name

string

Last name (max 256 characters).

suffix

string

Name suffix, e.g. "Jr." or "PhD" (max 64 characters).

alias

string

Legal alias (max 512 characters).

nickname

string

Casual nickname (max 256 characters).

birthday

date

Birthday as YYYY-MM-DD. Use 0000 as the year when it is unknown, e.g. 0000-06-03.

anniversary

date

Anniversary as YYYY-MM-DD. Use 0000 as the year when it is unknown.

flagged

boolean

Whether the contact is flagged.

tagline

string

Tagline (max 512 characters).

hobbies

string

Hobbies (max 1024 characters).

category

string

Category name. Created if it does not exist. Send null or "" to clear.

keywords

List of keyword names (max 64). Keywords that do not exist are created. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

extra_fields

object

Extra (custom) field values, keyed by the field's default identifier even if it has been renamed. Each value is an object with a value key. Fields you leave out are not changed; send null or {} to clear all of them.

emails

Email addresses of the contact. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

urls

Websites of the contact. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

social_profiles

Social profiles of the contact. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

phone_numbers

Phone numbers of the contact. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

addresses

Postal addresses of the contact. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

details

string

Short notes about the contact (max 8000 characters). For longer text, link a note.

companies

Companies the contact works for (roles). Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

opportunities

Opportunities the contact is involved in (roles). Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

projects

Projects the contact is involved in (roles). Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

contacts

Other contacts this contact is related to. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

appointments

Appointments linked to the contact. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

groups

Groups linked to the contact. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

notes

Notes linked to the contact. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

tasks

Tasks linked to the contact. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

forms

Forms linked to the contact. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

email_messages

Emails to link to the contact. Write-only: linked emails are not returned on the contact; use GET /v1/{type}/{id}/emails instead. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

owner

string

Reference to the user responsible for the contact, e.g. /v1/users/1000. Defaults to the user making the request.

trashed

boolean

Set to false to restore the contact from the trash. Use DELETE to move it to the trash.

Responses

204

204 No Content

Note

Contacts in the trash

400400 Bad Request

404404 Not Found