Skip to content
Docs
Select language:English

/api/v1/inbox/bulk

POST
/api/v1/inbox/bulk
curl --request POST \
  --url https://example.com/api/v1/inbox/bulk \
  --header 'Content-Type: application/json' \
  --data '{ "ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "action": "accept_names", "typeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "to": { "placeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "tagIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
ids
required
Array<string>
>= 1 items <= 200 items
action
required
string
Allowed values: accept_names set_type set_place set_tags discard
typeId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
to
Any of:
object
placeId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
tagIds
Array<string>
<= 50 items

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
results
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
ok
required
boolean
error
string
undo
object
eventId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
until
required
string
Examplegenerated
{
  "results": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "ok": true,
      "error": "example"
    }
  ],
  "undo": {
    "eventId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "until": "example"
  }
}