Change a contact: fields, tags, custom fields, identities

Before you call

Credential

Authorization: Bearer $KEY

Scope

contacts:write

Graphql

Mutation.contactsContactUpdate

Sdk

contacts.contact.update

Cli

contacts contact update

Events

contacts.contact.updated

Parameters

• idstring (uuid)required
  In the path

Request bodyapplication/json, required

• namestring
  At most 200 characters.
• firstNamestring or null
• lastNamestring or null
• emailstring or null
• phonestring or null
• identitieslist of object
  • kindstringrequired
    Pattern: ^(email|phone|whatsapp|handle:[a-z0-9_.-]{1,30}|external:[a-z0-9_.-]{1,30})$.
  • valuestringrequired
    At most 320 characters.
  • primaryboolean
  • verifiedboolean
• companyIdstring (uuid) or null
• companystring
  A company name or domain; found or created At most 200 characters.
• ownerstring or null
• lifecyclestring
  One of: subscriber, lead, customer, partner, other.
• sourcestring
  At most 80 characters.
• languagestring or null
• countrystring or null
• timezonestring or null
• tagslist of string
• customobject
• removeTagslist of string
• removeIdentitieslist of object
  • kindstringrequired
    Pattern: ^(email|phone|whatsapp|handle:[a-z0-9_.-]{1,30}|external:[a-z0-9_.-]{1,30})$.
  • valuestringrequired
    At most 320 characters.
• expectRevinteger
  At least 1.

Responses

• 200application/json
  Success

  object

• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring