Documents Plugin

Update an inbound capture address.

PUT

http://localhost:3000/api/plugins/docs/inbound-addresses/{id}

curl -X PUT 'http://localhost:3000/api/plugins/docs/inbound-addresses/string' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "organizationId": "string",
  "senderAllowlist": [
    "string"
  ],
  "importBodyAsNote": true,
  "isActive": true
}'

const body = `{
  "organizationId": "string",
  "senderAllowlist": [
    "string"
  ],
  "importBodyAsNote": true,
  "isActive": true
}`;

const response = await fetch('http://localhost:3000/api/plugins/docs/inbound-addresses/string', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "organizationId": "string",
  "senderAllowlist": [
    "string"
  ],
  "importBodyAsNote": true,
  "isActive": true
}'''

response = requests.put(
    'http://localhost:3000/api/plugins/docs/inbound-addresses/string',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "organizationId": "string",
  "senderAllowlist": [
    "string"
  ],
  "importBodyAsNote": true,
  "isActive": true
}

Body

application/json

organizationIdstring

senderAllowlistArray<string>

importBodyAsNoteboolean

isActiveboolean

Parameters

idstringrequiredpath

Response

200OK

Address updated.

Stack Overflow Website Demo