Contact Phones

On this page, we'll dive into the different contact phone endpoints you can use to manage them programmatically.

The Contact Phone object

Contact phone objects represent a single phone for a contact related to a commercial risk profile. They contain the following properties and relationships:

Commercial-only Properties

These properties are available only for commercial risk profiles.
  • Name
    contact
    Type
    string
    Description

    The UUID of the contact this phone belongs to. Only applicable when creating a new email outside the contacts endpoints.

  • Name
    phone
    Type
    string
    Description

    The phone number for the contact

  • Name
    extension
    Type
    nullable string
    Description

    The extension for the phone number, if applicable

  • Name
    type
    Type
    enum
    Description

    The type of phone

    • Name
      work
      Description
      work
    • Name
      home
      Description
      home
    • Name
      mobile
      Description
      mobile
    • Name
      fax
      Description
      fax
    • Name
      other
      Description
      other

Meta

  • Name
    created
    Type
    timestamp
    Description

    An ISO-8601 timestamp (UTC) indicating when the contact phone was created

  • Name
    updated
    Type
    timestamp
    Description

    An ISO-8601 timestamp (UTC) indicating when the contact phone was last updated