Batch delete contacts
POST https://contacts.8x8.com/api/v1/accounts/:accountId/contacts/batches/deleteContacts
Use this endpoint to delete multiple/all contacts in batch. Provide ids or msisdns to remove specific contacts, or set "all": true to delete all contacts in your account.
Request
Path Parameters
Possible values: >= 32 characters and <= 36 characters, Value must match regular expression ^[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}$
You must replace {accountId} with the accountid that you want to use.
Body
Set true to delete all contacts in your account
Accepted
Schema
Batch job id
The type of the batch job
Possible values: [createContacts, deleteContacts, copyContacts, moveContacts, deleteGroups]
The status of the batch job
Possible values: [queued, inProgress, failed, completed, stopped, timeout]
Job created date and time
{
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type":"createContacts",
"status":"queued",
"createdAt":"string"
}
Bad request error response
Schema
Error code
Error description
Unique id of error. You can use it as reference when sending enquiries to 8x8 support
Data and time of the error occurence
{
"code":1001,
"message":"Provided subAccountId doesn't belongs to your account",
"errorId":"91b106f0-c0da-4aba-a43a-7af9c5893a80",
"timestamp":"2017-04-19T02:31:19.4297387+00:00"
}
{
"code":1002,
"message":"Invalid MSISDN format (not E.164 international number)",
"errorId":"b4478860-b76c-e811-814e-022a35cc1c71",
"timestamp":"2018-08-04T09:25:40.9235752+00:00"
}
Source: https://developer.8x8.com/connect/reference/batch-delete-contacts · 8x8 CPaaS Developer Docs. Synced for support deflection.
0 Comments