Archive client
POST
apiKeyheader
AuthorizationBearer <token>An API key (blk_…) from Settings → API keys.
id*stringapplication/json- response
id*stringworkspaceId*stringtype*stringValue in
"company""individual"name*stringemail*string|nullphone*string|nullwebsite*string|nulltaxId*string|nulladdressLine1*string|nulladdressLine2*string|nullcity*string|nullstate*string|nullpostalCode*string|nullcountry*string|nullcurrency*string|nullpaymentTermsDays*|Range
-9007199254740991 <= value <= 9007199254740991notes*string|nullstatus*stringValue in
"active""archived"archivedAt*|Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timecreatedAt*stringMatch
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timeupdatedAt*stringMatch
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timecurl -X POST 'https://your-billleaf-api/v1/clients/string/archive'Example Response200
{ "id": "string", "workspaceId": "string", "type": "company", "name": "string", "email": "string", "phone": "string", "website": "string", "taxId": "string", "addressLine1": "string", "addressLine2": "string", "city": "string", "state": "string", "postalCode": "string", "country": "string", "currency": "string", "paymentTermsDays": -9007199254740991, "notes": "string", "status": "active", "archivedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}