Activity

Record a custom event associated to an account, person or deal.

These activities show up on the activity feed of the corresponding entity and can be leveraged to trigger drip campaigns and other automation. For integration with drip campaigns make sure that what you pass in the Title property matches the start / stop value specified for the campaign.

post/api/v1/activities/customactivity

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/activities/customactivity
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Request body

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
Titlestring nullable
Descriptionstring nullable
ActivityDatastring nullable
ActivityDateTimestring date-time
ActivityType10 | 50 | 51 | 52 | 53 | 54 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 210 | 211 | 212 | 213 | 214 | 215 | 216 | 217 | 218 | 219 | 220 | 300 | 301 | 304 | 305 | 306 | 307 | 400 | 401 | 402 | 403 | 500 | 501 | 502 | 503

10 - Custom, 50 - Note, 51 - Email, 52 - PhoneCall, 53 - Meeting, 54 - Chat, 100 - AccountCreated, 101 - AccountUpdated, 102 - AccountAddPerson, 103 - AccountStageUpdated, 104 - AccountDeleted, 105 - AccountBillingInformationUpdated, 106 - AccountSubscriptionPlanUpdated, 107 - AccountSubscriptionPaymentCollected, 108 - AccountSubscriptionPaymentDeclined, 109 - AccountBillingInformationRequested, 110 - AccountBillingInvoiceEmailSent, 111 - AccountRemovePerson, 112 - AccountPaidSubscriptionCreated, 113 - AccountBillingInformationRemoved, 114 - AccountPrimaryPersonUpdated, 115 - AccountBillingInvoiceCreated, 116 - AccountSubscriptionStarted, 117 - AccountSubscriptionRenewalExtended, 118 - AccountSubscriptionAddOnsChanged, 119 - AccountSubscriptionCancellationRequested, 120 - AccountBillingInvoiceDeleted, 121 - AccountPersonRoleUpdated, 122 - AccountProductsChanged, 200 - PersonCreated, 201 - PersonUpdated, 202 - PersonDeleted, 203 - PersonLogin, 204 - PersonListSubscribed, 205 - PersonListUnsubscribed, 206 - PersonSegmentAdded, 207 - PersonSegmentRemoved, 208 - PersonEmailOpened, 209 - PersonEmailClicked, 210 - PersonEmailBounce, 211 - PersonEmailSpam, 212 - PersonSupportTicketCreated, 213 - PersonSupportTicketUpdated, 214 - PersonLeadFormSubmitted, 215 - PersonListConfirmed, 216 - PersonEmailSubscribed, 217 - PersonEmailUnsubscribed, 218 - PersonTemporaryPasswordSet, 219 - PersonSupportTicketClosed, 220 - PersonTwoFactorRecoveryCodesRegenerated, 300 - DealCreated, 301 - DealUpdated, 304 - DealDeleted, 305 - DealDueDate, 306 - TaskCreated, 307 - TaskUpdated, 400 - PlanCreated, 401 - PlanUpdated, 402 - AddOnCreated, 403 - AddOnUpdated, 500 - DiscordUserLinked, 501 - DiscordUserAddedToServer, 502 - DiscordUserRolesUpdated, 503 - DiscordUserRemovedFromServer

EntityType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13

0 - None, 1 - Account, 2 - Person, 3 - Deal, 4 - Case, 5 - Invoice, 6 - EmailLog, 7 - Plan, 8 - DiscountCoupon, 9 - AddOn, 10 - Task, 11 - Segment, 12 - Broadcast, 13 - Article

EntityUidstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.