For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update Contact

Replace a contact with the supplied fields.

Read Get Contact first and preserve all fields and arrays that should remain after the update.

Behaviour

Supplied arrays replace their stored values; changing companyId can be rejected when the contact has quotations, an invitation, or a portal user.

reportsToId must name another contact in the same company — the contact itself is not accepted (400 contact_invalid_reports_to otherwise).

A 404 carries contact_not_found for the addressed contact and company_not_found for a companyId that names no company you can reach.

Requires the contacts:write scope.

put
Authorizations
AuthorizationstringRequired

API key sent as a bearer token (mk_live_… / mk_test_…).

Path parameters
contactIdstringRequiredPattern: ^CONT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Body

Data schema used by Create Contact (POST /v1/contacts). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ.

statusstring · enumOptionalPossible values:
firstNamestring · min: 1 · max: 255Required
lastNamestring · min: 1 · max: 255Required
companyIdstringRequiredPattern: ^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
sameAsCompanybooleanOptional
tagsstring[] · max: 50Optional

Up to 50 tags.

linkedInAccountstring · min: 1 · max: 255Optional
positionstring · min: 1 · max: 255Optional
reportsToIdstringOptionalPattern: ^CONT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Responses
200

Successful response.

application/json
put/v1/contacts/{contactId}
PUT /v1/contacts/{contactId} HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 343

{
  "status": "ACTIVE",
  "firstName": "text",
  "lastName": "text",
  "companyId": "text",
  "sameAsCompany": true,
  "address": {
    "street": "text",
    "city": "text",
    "postcode": "text",
    "country": "text"
  },
  "tags": [
    "text"
  ],
  "phoneNumbers": [
    {
      "type": "WORK",
      "number": "text"
    }
  ],
  "emails": [
    {
      "type": "WORK",
      "mail": "text"
    }
  ],
  "linkedInAccount": "text",
  "position": "text",
  "reportsToId": "text"
}
{
  "data": {
    "contactId": "CONT-123e4567-e89b-12d3-a456-426614174000",
    "contactNumericId": 1,
    "firstName": "text",
    "lastName": "text",
    "companyId": "text",
    "status": "ACTIVE",
    "phoneNumbers": [
      {
        "type": "WORK",
        "number": "text"
      }
    ],
    "emails": [
      {
        "type": "WORK",
        "mail": "text"
      }
    ],
    "isUserAssigned": true,
    "isInvited": true,
    "lastActivityAt": "text",
    "createdAt": "text",
    "modifiedAt": "text",
    "sameAsCompany": true,
    "address": {
      "street": "text",
      "city": "text",
      "postcode": "text",
      "country": "text"
    },
    "tags": [
      "text"
    ],
    "linkedInAccount": "text",
    "position": "text",
    "reportsToId": "text",
    "reportsToName": "text"
  }
}

Last updated

Was this helpful?