API Reference / Contacts

PUT /contacts/{contact_id}/relationships/{relationship_id}

Update a specific relationship

Replaces a relationship outright: send relationship_type_id and both related_contacts entries in full. The type can change and one contact can be swapped, but the path contact must remain a party.

Path parameters

Name Type Description
contact_id req string Contact ID
relationship_id req string Relationship ID

Request body

  • relationship_type_idstringbson-id

    ID of the relationship type

  • related_contactsarray<object>

    Related contacts with relationship variant names

    array item fields →
    • contact_idstringbson-id

      ID of the contact

    • variant_idstringbson-id

      ID of the relationship variant

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object fields →
    • relationshipobject

      The relationship mapping between contacts

      object fields →
      • idstringbson-id

        ID of the relationship

      • relationship_type_idstringbson-idrequired

        ID of the relationship type

      • related_contactsarray<object>required

        The contacts participating in the relationship along with their associated variant names

        array item fields →
        • variant_idstringbson-id

          ID of the relationship variant

        • variant_namestring

          The name of the variant

        • contact_idstringbson-id

          ID of the contact

        • first_namestring

          The first name of the contact

        • last_namestring

          The last name of the contact

        • photo_urlstring

          URL of the contact’s photo

        • company_idstringbson-id

          ID of the company, to which the contact belongs

        • company_namestring

          Name of the company, to whom the contact belongs

        • owner_idstringbson-id

          ID of the user, to whom the contact belongs

      • created_atstringdate-time

        Creation time of the relationship

      • modified_atstringdate-time

        Last modification time of the relationship

Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.

Related guides