Skip to content

Delete Draft Despatch Advice

DELETE
/despatch-advices/{id}

Soft-delete a despatch advice. Requires the despatch_advice:delete scope. Only documents in draft state can be deleted.

id
required
string
uuid
required
string format: uuid

The UUID of the draft despatch advice to delete.

Despatch advice deleted successfully.

object
message
required
string
Allowed value: Despatch advice deleted successfully.

Despatch advice not found or does not belong to your company.

object
message
required
string
Allowed value: Despatch advice not found.

Despatch advice is not in draft state or API key not associated with a company.

Any of:
object
message
required
string
Allowed value: Only draft despatch advices can be deleted.

Server error during deletion.

object
success
required
boolean
message
required
string
data
required
null
errors
required
null