Contact Logs

An object representing a record of an outreach to a person (or entity) in pursuit of finding family members with which to place one or more children.

• id* (string) - The primary key for the record.
• type* (string) - The JSON:API type specifier.
• attributes* (object) - Primary record attributes.

  • created-at* (string) - Date and time that the contact log was created in Binti.

  • updated-at* (string) - Date and time that the contact log was last updated in Binti.

  • contact-method* (string) - Method of contact.

    Allowed values

    • in_person
    • phone_call
    • direct_mail
    • email
    • text
    • social_media
    • other

  • contacted-on* (string) - Date and time that the contact was made.

  • contacted-on-time-known* (boolean) - Whether the date/time for the contact is known.

  • notes* (string) - Free-text notes on/about the contact.

  • status* (string) - Status of the contact.

    Allowed values

    • returned
    • attempted
    • successful
    • sent
    • delivered
    • opened
    • soft_bounced
    • hard_bounced

  • locked* (boolean) - Whether the contact log is locked. (True: the contact log is locked)

  • recorded-by* (string) - The email of the worker who logged the contact.

  • related-attributes* (object) - Properties form the related models included for conveinces these include external ids for both the child (Client ID) whom the contact is regarding and people contacted (Person ID) along with the email of the worker who recorded the calls email

    • children-client-ids* (array) - An array showing external identifiers (Client ID) for children the contact was made on behalf of.
    • connection-people-person-ids* (array) - An array showing external identifiers (Person IDs) for the person(s) to whom the contact was made.
    • agency-worker-email* (string) - The email of the worker who logged the contact.
• relationships (object) - Related objects. For each relationship, you can find detailed information about the object by issuing another API call to look it up by ID, or for certain endpoints, you will find details in the "included" section.
  • children (object) - A relationship with multiple entries.
    • data* (array) - Array of entries.

      • id* (string) - The ID of the other object.

      • type* (string) - Always children

        Allowed values

        • children
  • contact-people (object) - A relationship with multiple entries.
    • data* (array) - Array of entries.

      • id* (string) - The ID of the other object.

      • type* (string) - Always people

        Allowed values

        • people
  • recorded-by (object) - A relationship with a single entry.
    • data* (object) - The worker who logged the contact.

      • id* (string) - The ID of the other object.

      • type* (string) - Always agency_worker

        Allowed values

        • agency_worker