Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Two callback registrations may not share an event type if they have overlapping active date ranges.

Note: An HTTP 201 - Created response will be returned if the object has been successfully created.

Return JSON

A Callback entity.

...

Code Block
DELETE /companies/:company_id/config/callbacks/:callback_id

Notes:

An HTTP 200 - OK will be returned if the operation completes successfully.

An HTTP 404 - Not Found error will be returned if the entity does not exist.

This will set the end date of the callback to now and change it to inactive. If the start date of the callback was in the future, it will change that to now as well.

...

Code Block
{
   "event_type":"ack_participant_added",
   "participant":{
      "acquisition_campaign":{
         "id":"my_campaign"
      }
   }
}

Note: An HTTP 201 - Created will be returned if the callback was queued for send.

Code Block
{
   "message":"Created event for event_type 'person_added'",
   "event_id":"AB234SDFD234"
}

Note: An HTTP 404 - Not Found error will be returned if an active callback does not exist.

Code Block
{
   "errors":[
      {
         "message":"Could not find a callback registration for event type 'person_added'"
      }
   ]
}

...