Skip to content

API Reference / Relationship Types

PUT /relationship_types/{relationship_type_id}

Update a specific relationship type

Renames a relationship type's variants: send the full set of existing variant ids with new names. Variants cannot be added or removed, and a type cannot switch between symmetrical and directional.

Maintained by the OnePageCRM engineering team

Path parameters

Name Type Description
relationship_type_id req string Relationship type ID

Request body

  • variantsarray<object>

    The relationship variants.

    array item fields →
    • idstringbson-id

      ID of the relationship variant

    • namestring

      The relationship variant name.

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object fields →
    • relationship_typeobject

      The relationship types that identifies the relationships between the contacts.

      object fields →
      • idstringbson-id

        ID of the relationship type

      • symmetricalboolean

        Is the relationship symmetrical? (read only).

      • relationship_variantsarray<object>required

        The directional variants of this relationship type.

        array item fields →
        • idstringbson-id

          ID of the relationship type

        • namestring

          The relationship variant name

      • created_atstringdate-time

        Creation time of the relationship type

      • modified_atstringdate-time

        Last modification time of the relationship type

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

Related guides