Contact

PropertiesCopy Anchor Link

Inherits from Party, which adds no properties of its own.

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/tutorloop.com/contacts/contact_1",
  "$type": "Contact",
  "email": "malik@tutorloop.com",
  "phone": "Example phone",
  "name": "TutorLoop"
}

RelationshipsCopy Anchor Link

• A Contact becomes one Customer: a Contact becomes a Customer on accepting an Offer. becomes, inverse contact.
• A Contact is enrolled in many Sequences: a Sequence runs for an enrolled Contact until a reply, a purchase, or another exit Event ends it. enrolledIn, inverse enrolls.
• A Contact has many Enrollments: the Contact this run belongs to; pausing one Contact’s nurture pauses this Enrollment. enrollments, inverse runsFor.
• A Contact gives many Consents: a Contact grants Consents, each for one Purpose, with its basis and expiry. gives, inverse givenBy.
• A Contact has many Registrations: each Registration holds one Contact’s place; one Contact registers for many Gatherings. registrations, inverse names.
• A Contact resolves to one Person: each Contact is one Startup’s view of a Person shared across every Startup that knows them. resolvesTo, inverse contacts.
• A Contact works at one Organization: a Contact works for one Organization, as this Startup knows it. worksAt, inverse people.

VerbsCopy Anchor Link

1. createCreates a Contact.
   POST /{namespace}/contactsdoContact.created
2. getReturns one Contact by id.
   GET /{namespace}/contacts/{id}readNo Event
3. listReturns Contacts, newest first, one page at a time.
   GET /{namespace}/contactsreadNo Event
4. updateChanges the given properties of a Contact.
   PATCH /{namespace}/contacts/{id}doContact.updated
5. deleteDeletes a Contact; its history is kept.
   DELETE /{namespace}/contacts/{id}doContact.deleted
6. enrichEnrich fills a Contact’s missing fields from outside sources and marks each value with where it came from.
   POST /{namespace}/contacts/{contact}/enrichdoContact.enriched
7. enrollEnroll adds a Contact to a Sequence, which sends its steps until the Contact replies or exits.
   POST /{namespace}/contacts/{contact}/enrolldoContact.enrolled
8. mergeMerge joins a duplicate Contact into another, keeping every link, Message and Event on the one that remains.
   POST /{namespace}/contacts/{contact}/mergedoContact.merged
9. subscribeSubscribe records a Contact’s chosen topics and frequency from the hosted preference page, with Consent for each topic.
   POST /{namespace}/contacts/{contact}/subscribedoContact.subscribed
10. suppressSuppress records a Suppression for a Contact’s address, which every Startup honors forever.
    POST /{namespace}/contacts/{contact}/suppressdoContact.suppressed
11. unsubscribeUnsubscribe stops commercial Messages to a Contact in one click, for one topic or all, honored at once.
    POST /{namespace}/contacts/{contact}/unsubscribedoContact.unsubscribed

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

Call itCopy Anchor Link

Enroll the contact Malik Owens with a sequence.

ExampleCopy Anchor Link

owner@brightsmiles.dental books a demo of a dental-scheduling App and becomes a Contact. She has not given marketing Consent, so she gets replies about her demo but no newsletter.