Posts

get posts

GEThttps://ushahididocs.api.ushahidi.io/api/v5/posts

Authorization

bearerAuth

Query parameters

Response

200

OK

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v5/posts', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "status": 1,
  "message": "text"
}

Add a post

POSThttps://ushahididocs.api.ushahidi.io/api/v5/posts

Authorization

bearerAuth

Body

application/json

titlestring

contentstring

descriptionstring

typestring

form_idinteger

localestring

post_contentarray of object

completed_stagesarray of string

published_toarray of any

post_datestring

enabled_languagesobject

base_languagestring

any

Example: {"title":"test title","content":"test description","description":"<p>descrition</p>","type":"report","form_id":1,"locale":"en_US","post_content":[{"id":1,"form_id":1,"label":"Main","priority":1,"required":false,"type":"post","show_when_published":true,"task_is_internal_only":false,"fields":[{"id":7,"key":"last_location","label":"Last Location","input":"text","type":"varchar","required":false,"priority":5,"cardinality":1,"response_private":false,"form_stage_id":1,"translations":[],"value":{"value":"Nairobi"}},{"id":8,"key":"last_location_point","label":"Last Location (point)","input":"location","type":"point","required":false,"priority":5,"cardinality":0,"response_private":false,"form_stage_id":1,"translations":[],"value":{}},{"id":9,"key":"geometry_test","label":"Geometry test","input":"text","type":"geometry","required":false,"priority":5,"cardinality":1,"response_private":false,"form_stage_id":1,"translations":[],"value":{}}],"translations":[]},{"id":2,"form_id":1,"label":"2nd step","priority":2,"required":false,"":"task","show_when_published":true,"task_is_internal_only":false,"fields":[{"id":13,"key":"person_status","label":"Person Status","input":"select","type":"varchar","required":false,"priority":5,"options":["information_sought","is_note_author","believed_alive","believed_missing","believed_dead"],"cardinality":0,"response_private":false,"form_stage_id":2,"translations":[],"value":{}}],"translations":[]}],"completed_stages":[],"published_to":[],"post_date":"2022-08-28T11:51:13","enabled_languages":{},"base_language":""}

Response

201401422500

Created

Body

application/json

resultsarray of object

countinteger (int32)

linksobject

metaobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v5/posts', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "test title",
      "content": "test description",
      "description": "<p>descrition</p>",
      "type": "report",
      "form_id": 1,
      "locale": "en_US",
      "post_content": [
        {
          "id": 1,
          "form_id": 1,
          "label": "Main",
          "priority": 1,
          "required": false,
          "type": "post",
          "show_when_published": true,
          "task_is_internal_only": false,
          "fields": [
            {
              "id": 7,
              "key": "last_location",
              "label": "Last Location",
              "input": "text",
              "type": "varchar",
              "required": false,
              "priority": 5,
              "cardinality": 1,
              "response_private": false,
              "form_stage_id": 1,
              "translations": [],
              "value": {
                "value": "Nairobi"
              }
            },
            {
              "id": 8,
              "key": "last_location_point",
              "label": "Last Location (point)",
              "input": "location",
              "type": "point",
              "required": false,
              "priority": 5,
              "cardinality": 0,
              "response_private": false,
              "form_stage_id": 1,
              "translations": [],
              "value": {}
            },
            {
              "id": 9,
              "key": "geometry_test",
              "label": "Geometry test",
              "input": "text",
              "type": "geometry",
              "required": false,
              "priority": 5,
              "cardinality": 1,
              "response_private": false,
              "form_stage_id": 1,
              "translations": [],
              "value": {}
            }
          ],
          "translations": []
        },
        {
          "id": 2,
          "form_id": 1,
          "label": "2nd step",
          "priority": 2,
          "required": false,
          "": "task",
          "show_when_published": true,
          "task_is_internal_only": false,
          "fields": [
            {
              "id": 13,
              "key": "person_status",
              "label": "Person Status",
              "input": "select",
              "type": "varchar",
              "required": false,
              "priority": 5,
              "options": [
                "information_sought",
                "is_note_author",
                "believed_alive",
                "believed_missing",
                "believed_dead"
              ],
              "cardinality": 0,
              "response_private": false,
              "form_stage_id": 2,
              "translations": [],
              "value": {}
            }
          ],
          "translations": []
        }
      ],
      "completed_stages": [],
      "published_to": [],
      "post_date": "2022-08-28T11:51:13",
      "enabled_languages": {},
      "base_language": ""
    }),
});
const data = await response.json();

Response

201401422500

{
  "results": [
    {
      "id": 1,
      "form_id": 1,
      "user_id": "text",
      "type": "text",
      "title": "text",
      "slug": "text",
      "content": "text",
      "author_email": "text",
      "author_realname": "text",
      "status": "text",
      "published_to": [
        "text"
      ],
      "locale": "text",
      "created": "text",
      "updated": "text",
      "post_date": "text",
      "categories": [
        {
          "id": 1,
          "parent_id": "text",
          "tag": "text",
          "slug": "text",
          "type": "text",
          "color": "text",
          "icon": "text",
          "role": "text",
          "priority": 1,
          "created": "text",
          "base_language": "text",
          "pivot": {
            "post_id": 1,
            "tag_id": 1
          }
        }
      ],
      "post_content": [
        {
          "id": 1,
          "form_id": 1,
          "label": "text",
          "priority": 1,
          "required": 1,
          "type": "text",
          "description": "text",
          "show_when_published": true,
          "task_is_internal_only": true,
          "fields": [
            {
              "id": 1,
              "key": "text",
              "label": "text",
              "instructions": "text",
              "input": "text",
              "type": "text",
              "required": 1,
              "default": "text",
              "priority": 1,
              "options": [
                {
                  "id": 1,
                  "parent_id": "text",
                  "tag": "text",
                  "slug": "text",
                  "type": "text",
                  "color": "text",
                  "icon": "text",
                  "description": "text",
                  "role": "text",
                  "priority": 1,
                  "children": [
                    {
                      "id": 1,
                      "parent_id": 1,
                      "tag": "text",
                      "slug": "text",
                      "type": "text",
                      "color": "text",
                      "icon": "text",
                      "description": "text",
                      "role": "text",
                      "priority": 1,
                      "children": [
                        "text"
                      ],
                      "parent": {
                        "id": 1,
                        "parent_id": "text",
                        "tag": "text",
                        "slug": "text",
                        "type": "text",
                        "color": "text",
                        "icon": "text",
                        "description": "text",
                        "role": "text",
                        "priority": 1,
                        "parent": "text",
                        "translations": {
                          "es": {
                            "tag": "text"
                          }
                        }
                      },
                      "enabled_languages": {
                        "default": "text",
                        "available": [
                          "text"
                        ]
                      },
                      "translations": {
                        "es": {
                          "tag": "text"
                        },
                        "enabled_languages": {
                          "es": {
                            "tag": "text"
                          }
                        }
                      }
                    }
                  ],
                  "parent": {
                    "id": 1,
                    "parent_id": "text",
                    "tag": "text",
                    "slug": "text",
                    "type": "text",
                    "color": "text",
                    "icon": "text",
                    "description": "text",
                    "role": "text",
                    "priority": 1,
                    "parent": "text",
                    "translations": {
                      "es": {
                        "tag": "text"
                      }
                    },
                    "enabled_languages": {
                      "default": "text",
                      "available": [
                        "text"
                      ]
                    }
                  }
                }
              ],
              "cardinality": 1,
              "config": [
                "text"
              ],
              "form_stage_id": 1,
              "response_private": 1,
              "description": "text",
              "translations": [
                "text"
              ],
              "value": {
                "id": 1,
                "post_id": 1,
                "form_attribute_id": 1,
                "value": {
                  "lon": "text",
                  "lat": "text"
                },
                "created": "text",
                "translations": [
                  "text"
                ]
              }
            }
          ],
          "translations": [
            "text"
          ]
        }
      ],
      "completed_stages": [
        {
          "form_stage_id": 1,
          "post_id": 1,
          "completed": 1
        }
      ],
      "translations": [
        "text"
      ],
      "enabled_languages": {
        "default": "text",
        "available": [
          "text"
        ]
      },
      "locks": [
        "text"
      ],
      "allowed_privileges": [
        "text"
      ],
      "message": {
        "id": 1,
        "url": "text"
      },
      "contact": {
        "id": 1,
        "url": "text"
      }
    }
  ],
  "count": 1,
  "links": {
    "first": "text",
    "last": "text",
    "prev": "text",
    "next": "text"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Get a post

GEThttps://ushahididocs.api.ushahidi.io/api/v5/posts/{id}

Authorization

bearerAuth

Path parameters

id*string

Query parameters

Response

200401404

OK

Body

application/json

resultsarray of object

countinteger (int32)

linksobject

metaobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v5/posts/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200401404

{
  "results": [
    {
      "id": 1,
      "form_id": 1,
      "user_id": "text",
      "type": "text",
      "title": "text",
      "slug": "text",
      "content": "text",
      "author_email": "text",
      "author_realname": "text",
      "status": "text",
      "published_to": [
        "text"
      ],
      "locale": "text",
      "created": "text",
      "updated": "text",
      "post_date": "text",
      "categories": [
        {
          "id": 1,
          "parent_id": "text",
          "tag": "text",
          "slug": "text",
          "type": "text",
          "color": "text",
          "icon": "text",
          "role": "text",
          "priority": 1,
          "created": "text",
          "base_language": "text",
          "pivot": {
            "post_id": 1,
            "tag_id": 1
          }
        }
      ],
      "post_content": [
        {
          "id": 1,
          "form_id": 1,
          "label": "text",
          "priority": 1,
          "required": 1,
          "type": "text",
          "description": "text",
          "show_when_published": true,
          "task_is_internal_only": true,
          "fields": [
            {
              "id": 1,
              "key": "text",
              "label": "text",
              "instructions": "text",
              "input": "text",
              "type": "text",
              "required": 1,
              "default": "text",
              "priority": 1,
              "options": [
                {
                  "id": 1,
                  "parent_id": "text",
                  "tag": "text",
                  "slug": "text",
                  "type": "text",
                  "color": "text",
                  "icon": "text",
                  "description": "text",
                  "role": "text",
                  "priority": 1,
                  "children": [
                    {
                      "id": 1,
                      "parent_id": 1,
                      "tag": "text",
                      "slug": "text",
                      "type": "text",
                      "color": "text",
                      "icon": "text",
                      "description": "text",
                      "role": "text",
                      "priority": 1,
                      "children": [
                        "text"
                      ],
                      "parent": {
                        "id": 1,
                        "parent_id": "text",
                        "tag": "text",
                        "slug": "text",
                        "type": "text",
                        "color": "text",
                        "icon": "text",
                        "description": "text",
                        "role": "text",
                        "priority": 1,
                        "parent": "text",
                        "translations": {
                          "es": {
                            "tag": "text"
                          }
                        }
                      },
                      "enabled_languages": {
                        "default": "text",
                        "available": [
                          "text"
                        ]
                      },
                      "translations": {
                        "es": {
                          "tag": "text"
                        },
                        "enabled_languages": {
                          "es": {
                            "tag": "text"
                          }
                        }
                      }
                    }
                  ],
                  "parent": {
                    "id": 1,
                    "parent_id": "text",
                    "tag": "text",
                    "slug": "text",
                    "type": "text",
                    "color": "text",
                    "icon": "text",
                    "description": "text",
                    "role": "text",
                    "priority": 1,
                    "parent": "text",
                    "translations": {
                      "es": {
                        "tag": "text"
                      }
                    },
                    "enabled_languages": {
                      "default": "text",
                      "available": [
                        "text"
                      ]
                    }
                  }
                }
              ],
              "cardinality": 1,
              "config": [
                "text"
              ],
              "form_stage_id": 1,
              "response_private": 1,
              "description": "text",
              "translations": [
                "text"
              ],
              "value": {
                "id": 1,
                "post_id": 1,
                "form_attribute_id": 1,
                "value": {
                  "lon": "text",
                  "lat": "text"
                },
                "created": "text",
                "translations": [
                  "text"
                ]
              }
            }
          ],
          "translations": [
            "text"
          ]
        }
      ],
      "completed_stages": [
        {
          "form_stage_id": 1,
          "post_id": 1,
          "completed": 1
        }
      ],
      "translations": [
        "text"
      ],
      "enabled_languages": {
        "default": "text",
        "available": [
          "text"
        ]
      },
      "locks": [
        "text"
      ],
      "allowed_privileges": [
        "text"
      ],
      "message": {
        "id": 1,
        "url": "text"
      },
      "contact": {
        "id": 1,
        "url": "text"
      }
    }
  ],
  "count": 1,
  "links": {
    "first": "text",
    "last": "text",
    "prev": "text",
    "next": "text"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Edit post

PUThttps://ushahididocs.api.ushahidi.io/api/v5/posts/{id}

Authorization

bearerAuth

Path parameters

id*string

Body

application/json

titlestring

contentstring

descriptionstring

typestring

form_idinteger

localestring

post_contentarray of object

completed_stagesarray of string

published_toarray of any

post_datestring

enabled_languagesobject

base_languagestring

any

Example: {"title":"test title 2","content":"test description","description":"<p>descrition</p>","type":"report","form_id":1,"locale":"en_US","post_content":[{"id":1,"form_id":1,"label":"Main","priority":1,"required":false,"type":"post","show_when_published":true,"task_is_internal_only":false,"fields":[{"id":8,"key":"last_location_point","label":"Last Location (point)","input":"location","type":"point","required":false,"priority":5,"cardinality":0,"response_private":false,"form_stage_id":1,"translations":[],"value":{}},{"id":9,"key":"geometry_test","label":"Geometry test","input":"text","type":"geometry","required":false,"priority":5,"cardinality":1,"response_private":false,"form_stage_id":1,"translations":[],"value":{}}],"translations":[]},{"id":2,"form_id":1,"label":"2nd step","priority":2,"required":false,"":"task","show_when_published":true,"task_is_internal_only":false,"fields":[{"id":13,"key":"person_status","label":"Person Status","input":"select","type":"varchar","required":false,"priority":5,"options":["information_sought","is_note_author","believed_alive","believed_missing","believed_dead"],"cardinality":0,"response_private":false,"form_stage_id":2,"translations":[],"value":{}}],"translations":[]}],"completed_stages":[],"published_to":[],"post_date":"2022-12-28T11:51:13","enabled_languages":{},"base_language":""}

Response

200500

OK

Body

application/json

resultsarray of object

countinteger (int32)

linksobject

metaobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v5/posts/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "test title 2",
      "content": "test description",
      "description": "<p>descrition</p>",
      "type": "report",
      "form_id": 1,
      "locale": "en_US",
      "post_content": [
        {
          "id": 1,
          "form_id": 1,
          "label": "Main",
          "priority": 1,
          "required": false,
          "type": "post",
          "show_when_published": true,
          "task_is_internal_only": false,
          "fields": [
            {
              "id": 8,
              "key": "last_location_point",
              "label": "Last Location (point)",
              "input": "location",
              "type": "point",
              "required": false,
              "priority": 5,
              "cardinality": 0,
              "response_private": false,
              "form_stage_id": 1,
              "translations": [],
              "value": {}
            },
            {
              "id": 9,
              "key": "geometry_test",
              "label": "Geometry test",
              "input": "text",
              "type": "geometry",
              "required": false,
              "priority": 5,
              "cardinality": 1,
              "response_private": false,
              "form_stage_id": 1,
              "translations": [],
              "value": {}
            }
          ],
          "translations": []
        },
        {
          "id": 2,
          "form_id": 1,
          "label": "2nd step",
          "priority": 2,
          "required": false,
          "": "task",
          "show_when_published": true,
          "task_is_internal_only": false,
          "fields": [
            {
              "id": 13,
              "key": "person_status",
              "label": "Person Status",
              "input": "select",
              "type": "varchar",
              "required": false,
              "priority": 5,
              "options": [
                "information_sought",
                "is_note_author",
                "believed_alive",
                "believed_missing",
                "believed_dead"
              ],
              "cardinality": 0,
              "response_private": false,
              "form_stage_id": 2,
              "translations": [],
              "value": {}
            }
          ],
          "translations": []
        }
      ],
      "completed_stages": [],
      "published_to": [],
      "post_date": "2022-12-28T11:51:13",
      "enabled_languages": {},
      "base_language": ""
    }),
});
const data = await response.json();

Response

200500

{
  "results": [
    {
      "id": 1,
      "form_id": 1,
      "user_id": "text",
      "type": "text",
      "title": "text",
      "slug": "text",
      "content": "text",
      "author_email": "text",
      "author_realname": "text",
      "status": "text",
      "published_to": [
        "text"
      ],
      "locale": "text",
      "created": "text",
      "updated": "text",
      "post_date": "text",
      "categories": [
        {
          "id": 1,
          "parent_id": "text",
          "tag": "text",
          "slug": "text",
          "type": "text",
          "color": "text",
          "icon": "text",
          "role": "text",
          "priority": 1,
          "created": "text",
          "base_language": "text",
          "pivot": {
            "post_id": 1,
            "tag_id": 1
          }
        }
      ],
      "post_content": [
        {
          "id": 1,
          "form_id": 1,
          "label": "text",
          "priority": 1,
          "required": 1,
          "type": "text",
          "description": "text",
          "show_when_published": true,
          "task_is_internal_only": true,
          "fields": [
            {
              "id": 1,
              "key": "text",
              "label": "text",
              "instructions": "text",
              "input": "text",
              "type": "text",
              "required": 1,
              "default": "text",
              "priority": 1,
              "options": [
                {
                  "id": 1,
                  "parent_id": "text",
                  "tag": "text",
                  "slug": "text",
                  "type": "text",
                  "color": "text",
                  "icon": "text",
                  "description": "text",
                  "role": "text",
                  "priority": 1,
                  "children": [
                    {
                      "id": 1,
                      "parent_id": 1,
                      "tag": "text",
                      "slug": "text",
                      "type": "text",
                      "color": "text",
                      "icon": "text",
                      "description": "text",
                      "role": "text",
                      "priority": 1,
                      "children": [
                        "text"
                      ],
                      "parent": {
                        "id": 1,
                        "parent_id": "text",
                        "tag": "text",
                        "slug": "text",
                        "type": "text",
                        "color": "text",
                        "icon": "text",
                        "description": "text",
                        "role": "text",
                        "priority": 1,
                        "parent": "text",
                        "translations": {
                          "es": {
                            "tag": "text"
                          }
                        }
                      },
                      "enabled_languages": {
                        "default": "text",
                        "available": [
                          "text"
                        ]
                      },
                      "translations": {
                        "es": {
                          "tag": "text"
                        },
                        "enabled_languages": {
                          "es": {
                            "tag": "text"
                          }
                        }
                      }
                    }
                  ],
                  "parent": {
                    "id": 1,
                    "parent_id": "text",
                    "tag": "text",
                    "slug": "text",
                    "type": "text",
                    "color": "text",
                    "icon": "text",
                    "description": "text",
                    "role": "text",
                    "priority": 1,
                    "parent": "text",
                    "translations": {
                      "es": {
                        "tag": "text"
                      }
                    },
                    "enabled_languages": {
                      "default": "text",
                      "available": [
                        "text"
                      ]
                    }
                  }
                }
              ],
              "cardinality": 1,
              "config": [
                "text"
              ],
              "form_stage_id": 1,
              "response_private": 1,
              "description": "text",
              "translations": [
                "text"
              ],
              "value": {
                "id": 1,
                "post_id": 1,
                "form_attribute_id": 1,
                "value": {
                  "lon": "text",
                  "lat": "text"
                },
                "created": "text",
                "translations": [
                  "text"
                ]
              }
            }
          ],
          "translations": [
            "text"
          ]
        }
      ],
      "completed_stages": [
        {
          "form_stage_id": 1,
          "post_id": 1,
          "completed": 1
        }
      ],
      "translations": [
        "text"
      ],
      "enabled_languages": {
        "default": "text",
        "available": [
          "text"
        ]
      },
      "locks": [
        "text"
      ],
      "allowed_privileges": [
        "text"
      ],
      "message": {
        "id": 1,
        "url": "text"
      },
      "contact": {
        "id": 1,
        "url": "text"
      }
    }
  ],
  "count": 1,
  "links": {
    "first": "text",
    "last": "text",
    "prev": "text",
    "next": "text"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Delete post

DELETEhttps://ushahididocs.api.ushahidi.io/api/v5/posts/{id}

Authorization

bearerAuth

Path parameters

id*string

Response

200403

OK

Body

application/json

resultobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v5/posts/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200403

{
  "result": {
    "deleted": 96
  }
}

Patch post

PATCHhttps://ushahididocs.api.ushahidi.io/api/v5/posts/{id}

Authorization

bearerAuth

Path parameters

id*string

Body

application/json

titlestring

contentstring

descriptionstring

typestring

form_idinteger

localestring

post_contentarray of object

completed_stagesarray of string

published_toarray of any

post_datestring

enabled_languagesobject

base_languagestring

any

Example: {"status":"draft"}

Response

200422

OK

Body

application/json

resultsarray of object

countinteger (int32)

linksobject

metaobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v5/posts/{id}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "status": "draft"
    }),
});
const data = await response.json();

Response

200422

{
  "results": [
    {
      "id": 1,
      "form_id": 1,
      "user_id": "text",
      "type": "text",
      "title": "text",
      "slug": "text",
      "content": "text",
      "author_email": "text",
      "author_realname": "text",
      "status": "text",
      "published_to": [
        "text"
      ],
      "locale": "text",
      "created": "text",
      "updated": "text",
      "post_date": "text",
      "categories": [
        {
          "id": 1,
          "parent_id": "text",
          "tag": "text",
          "slug": "text",
          "type": "text",
          "color": "text",
          "icon": "text",
          "role": "text",
          "priority": 1,
          "created": "text",
          "base_language": "text",
          "pivot": {
            "post_id": 1,
            "tag_id": 1
          }
        }
      ],
      "post_content": [
        {
          "id": 1,
          "form_id": 1,
          "label": "text",
          "priority": 1,
          "required": 1,
          "type": "text",
          "description": "text",
          "show_when_published": true,
          "task_is_internal_only": true,
          "fields": [
            {
              "id": 1,
              "key": "text",
              "label": "text",
              "instructions": "text",
              "input": "text",
              "type": "text",
              "required": 1,
              "default": "text",
              "priority": 1,
              "options": [
                {
                  "id": 1,
                  "parent_id": "text",
                  "tag": "text",
                  "slug": "text",
                  "type": "text",
                  "color": "text",
                  "icon": "text",
                  "description": "text",
                  "role": "text",
                  "priority": 1,
                  "children": [
                    {
                      "id": 1,
                      "parent_id": 1,
                      "tag": "text",
                      "slug": "text",
                      "type": "text",
                      "color": "text",
                      "icon": "text",
                      "description": "text",
                      "role": "text",
                      "priority": 1,
                      "children": [
                        "text"
                      ],
                      "parent": {
                        "id": 1,
                        "parent_id": "text",
                        "tag": "text",
                        "slug": "text",
                        "type": "text",
                        "color": "text",
                        "icon": "text",
                        "description": "text",
                        "role": "text",
                        "priority": 1,
                        "parent": "text",
                        "translations": {
                          "es": {
                            "tag": "text"
                          }
                        }
                      },
                      "enabled_languages": {
                        "default": "text",
                        "available": [
                          "text"
                        ]
                      },
                      "translations": {
                        "es": {
                          "tag": "text"
                        },
                        "enabled_languages": {
                          "es": {
                            "tag": "text"
                          }
                        }
                      }
                    }
                  ],
                  "parent": {
                    "id": 1,
                    "parent_id": "text",
                    "tag": "text",
                    "slug": "text",
                    "type": "text",
                    "color": "text",
                    "icon": "text",
                    "description": "text",
                    "role": "text",
                    "priority": 1,
                    "parent": "text",
                    "translations": {
                      "es": {
                        "tag": "text"
                      }
                    },
                    "enabled_languages": {
                      "default": "text",
                      "available": [
                        "text"
                      ]
                    }
                  }
                }
              ],
              "cardinality": 1,
              "config": [
                "text"
              ],
              "form_stage_id": 1,
              "response_private": 1,
              "description": "text",
              "translations": [
                "text"
              ],
              "value": {
                "id": 1,
                "post_id": 1,
                "form_attribute_id": 1,
                "value": {
                  "lon": "text",
                  "lat": "text"
                },
                "created": "text",
                "translations": [
                  "text"
                ]
              }
            }
          ],
          "translations": [
            "text"
          ]
        }
      ],
      "completed_stages": [
        {
          "form_stage_id": 1,
          "post_id": 1,
          "completed": 1
        }
      ],
      "translations": [
        "text"
      ],
      "enabled_languages": {
        "default": "text",
        "available": [
          "text"
        ]
      },
      "locks": [
        "text"
      ],
      "allowed_privileges": [
        "text"
      ],
      "message": {
        "id": 1,
        "url": "text"
      },
      "contact": {
        "id": 1,
        "url": "text"
      }
    }
  ],
  "count": 1,
  "links": {
    "first": "text",
    "last": "text",
    "prev": "text",
    "next": "text"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Add post in bulk

POSThttps://ushahididocs.api.ushahidi.io/api/v5/posts/bulk

Authorization

bearerAuth

Body

application/json

titlestring

contentstring

descriptionstring

typestring

form_idinteger

localestring

post_contentarray of object

completed_stagesarray of string

published_toarray of any

post_datestring

enabled_languagesobject

base_languagestring

any

Example: {"operation":"patch","items":[{"id":10006,"user_id":2,"form_id":1,"type":"report","author_email":"[e-mail]","author_realname":"Admin","status":"published","created":"2022-09-02T11:52:01+00:00","locale":"en_us","values":{"test_point":[{"lon":28.410584460421,"lat":7.2229816056086}],"last_location":["Nairobi"]},"post_date":"2022-09-02T11:51:13+00:00","tags":[],"published_to":[],"completed_stages":[],"sets":["1"]},{"id":10005,"user_id":2,"form_id":1,"type":"report","author_email":"[e-mail]","author_realname":"Admin","status":"published","created":"2022-09-02T11:52:01+00:00","locale":"en_us","values":{"test_point":[{"lon":28.410584460421,"lat":7.2229816056086}],"last_location":["Nairobi"]},"post_date":"2022-09-02T11:51:13+00:00","tags":[],"published_to":[],"completed_stages":[],"sets":["1"]}]}

Response

200422

OK

Body

application/json

resultsarray of object

countinteger (int32)

linksobject

metaobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://ushahididocs.api.ushahidi.io/api/v5/posts/bulk', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "operation": "patch",
      "items": [
        {
          "id": 10006,
          "user_id": 2,
          "form_id": 1,
          "type": "report",
          "author_email": "[e-mail]",
          "author_realname": "Admin",
          "status": "published",
          "created": "2022-09-02T11:52:01+00:00",
          "locale": "en_us",
          "values": {
            "test_point": [
              {
                "lon": 28.410584460421,
                "lat": 7.2229816056086
              }
            ],
            "last_location": [
              "Nairobi"
            ]
          },
          "post_date": "2022-09-02T11:51:13+00:00",
          "tags": [],
          "published_to": [],
          "completed_stages": [],
          "sets": [
            "1"
          ]
        },
        {
          "id": 10005,
          "user_id": 2,
          "form_id": 1,
          "type": "report",
          "author_email": "[e-mail]",
          "author_realname": "Admin",
          "status": "published",
          "created": "2022-09-02T11:52:01+00:00",
          "locale": "en_us",
          "values": {
            "test_point": [
              {
                "lon": 28.410584460421,
                "lat": 7.2229816056086
              }
            ],
            "last_location": [
              "Nairobi"
            ]
          },
          "post_date": "2022-09-02T11:51:13+00:00",
          "tags": [],
          "published_to": [],
          "completed_stages": [],
          "sets": [
            "1"
          ]
        }
      ]
    }),
});
const data = await response.json();

Response

200422

{
  "status": "completed"
}