API Reference
Log In
API Reference

/biz/api/guidelines/

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

šŸ“˜

API is in Beta state

This API endpoint is in Beta state right now and is subject to changes.
Even so, any changes to this API will be appropriately communicated.

Single Create

The following is a sample request payload. The response returned would contain the same data as sent.

{
	"email": "[email protected]",
	"guideline": "Junk foods are bad for health, say no to them",
	"task": "Disable junk",
	"images": ["https://upload.wikimedia.org/wikipedia/commons/2/2e/Fast_food_meal.jpg"]
}

Multiple Create

The following is a sample request payload. The response returned would contain the same data as sent.

[
  {
    "email": "[email protected]",
    "guideline": "Junk foods are bad for health, say no to them",
    "task": "Disable junk",
    "images": ["https://upload.wikimedia.org/wikipedia/commons/2/2e/Fast_food_meal.jpg"]
  },
  {
    "email": "[email protected]",
    "guideline": "Junk foods are bad for health, say no to them"
  }
]
Body Params
string

Piece of work to be assigned to SquadRun

string
required

Instructions for doing the task

string

Email of the point of contact for the guideline

images
array of strings

Array of Image URLs for the given guideline

images
Responses

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json