Markit AI LogoMarkit | Docs
Markit API

Data Capture

The data capture resource allows you to handle Create related functionality to build your audience. The following actions can be performed on this resource:

  • Subscribe to User
  • RSVP to Event

Subscribe to User

Subscribes a user to your Markit account. This simulates as if someone subscribed to your profile. This will by default trigger the Clicked Subscribe automation, which sends texts found within the automation to the user after subscribing.

    POST https://api.markitai.com/v1/data-capture/subscribe
ParameterTypeRequiredDefaultDescription
phoneNumberstringYes-The phone number of the recipient (US or non-US). Begin all phone numbers with a +. Ex: +1 234 567 8910
fullNamestringYes-The name for the contact.
formAnswersobjectNo-Form answers to be added to the user contact when they are subscribed. Must follow the format below (see Example Request with formAnswers), otherwise it will be marked as invalid:
disableMessagebooleanNofalseIf true, this will prevent the Clicked Subscribe automation from being triggered.
replacementTextstringNo-Specific replacement text that will replace part of the message sent to the user upon subscribing. If {REPLACE_TEXT} is added anywhere in their Clicked Subscribe automation messages, it will be swapped out by this param.

Example Request for formAnswers

{
  "formAnswers": {
    "question1_id": ["Answer 1"],
    "question2_id": ["Option A", "Option B"],
    "question3_id": ["Single answer"]
  }
}

Example Responses:

  1. Successful Subscribe to User
{ "uid": "abc123", "message": "Contact Subscribed!" }
  1. Already Subscribed to User:
{ "message": "Contact already subscribed!" }
  1. Contact Opted Out of User
{ "message": "Contact is opted out. Cannot subscribe the contact to the user." }

RSVP to Event

RSVP a user to an event. This simulates as if someone got a ticket or RSVP’d to one of your Markit events. This will also send the related automation texts associated with the event.

Note: We currently only support RSVP for free ticket types. Support for paid ticket options will be available in the future.

POST https://api.markitai.com/v1/data-capture/rsvp
ParameterTypeRequiredDefaultDescription
phoneNumberstringYes-The phone number of the recipient (US or non-US). Begin all phone numbers with a +. Ex: +1 234 567 8910
fullNamestringYes-The name for the contact.
eventIdstringYes-The event ID of the Markit event.
customTicketIdstringYes-The ID of the ticket type on Markit.

*This is not required if the event specified only contains one custom ticket option. In this case, it will default to use that customTicketId.
formAnswersobjectNo-Form answers to be added to the user contact when they are subscribed. Must follow the format below (see Example Request with formAnswers), otherwise it will be marked as invalid:
numberOfTicketsstringNo1The number of tickets the user is getting

Example Request for formAnswers

{
  "formAnswers": {
    "question1_id": ["Answer 1"],
    "question2_id": ["Option A", "Option B"],
    "question3_id": ["Single answer"]
  }
}

On this page