Delete an assignment

View as Markdown
DELETE /api/v1/assignments/{assignment}

Permanently deletes an assignment. This cannot be undone. Attempts to delete assignments with jobs that have invoices paid in full will fail.

Path parameters

  • assignment string Required

    The ID of the desired assignment (e.g., an_G5biPgc5Hc).

Responses

  • 200 application/json

    A successfully deleted assignment. Otherwise, this call returns an error, such as if the assignment has already been deleted.

    Hide response attributes Show response attributes object
    • deleted boolean
    • deleted_at integer

      Unix timestamp (seconds since epoch) of when the assignment was deleted.

    • id string

      The assignment ID.

    • object string

      Default value is assignment.
DELETE /api/v1/assignments/{assignment} 
curl \
 --request DELETE 'https://api.1099policy.com/api/v1/assignments/an_G5biPgc5Hc'
Response examples (200) 
{
  "id": "an_G5biPgc5Hc",
  "object": "assignment",
  "deleted": true,
  "deleted_at": 1640995200
}