Skip to content
campaiDeveloper
campai.com

Dispatch ยท Documents

POST/{organizationId}/{mandateId}/dispatch/documents/{documentId}/get

Update document send details

Updates the send details of a specific dispatch document for a given mandate and resends the document

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • mandate.read
  • dispatchDocument.edit
Also checked, depending on the request and the records it touches
  • getDispatchDocumentReadPermissions([document.type])

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • documentIdidrequired

Body

Content-Type: application/json

  • sendMethodstringrequired
    email postal
  • emailstring
  • addressobjectnullable
    7 properties
    • countrystringrequired
    • statestring
    • zipstringrequired

      at most 10 characters

    • citystringrequired

      at most 45 characters

    • addressLinestringrequired

      at most 45 characters

    • details1string

      at most 45 characters

    • details2string

      at most 45 characters

Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/dispatch/documents/YOUR_DOCUMENT_ID/get' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • resentnumber
  • creatednumber
Response200
{
  "resent": 1,
  "created": 1
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.