Skip to main content Link Search Menu Expand Document (external link)

createbuzz

description

Creates a new Buzz (workflow)

parameters

The templateID is the _id on a template buzz. Is is the number in the url after the …/go/ bit eg https://buzzy.buzz/go/b443c1f6c89b49014bfbee351

The X-Auth-Token and X-User-Id are derived from the values authToken and userId returned from the login endpoint and are used in the HTTP header.

resource

{
"participants": {
    "audience": [],
    "authors": [],
    "owners": ["<owner email address>"]
},
"templateID":"<enter your Buzzy template ID eg <somelongstring>",
"title":"<enter your title>"
}

response

Returns the status of the request

example

POST /api/createbuzz 
X-Auth-Token: <the authtoken you got back after authentication>
X-User-Id: <the userid you got back after authentication>

{
"participants": {
    "audience": [],
    "authors": [],
    "owners": ["<owner email address>"]
},
"templateID":"<template id>",
"title":"Test Create Buzz 1"
}

You should get back:

{
    "status": "success",
}