Bulk

Bulk Documentation

Contacts [BULK DELETE]

Contacts [BULK DELETE]

Request

Endpoint

DELETE /api/v2/contacts/bulk
Content-Type: application/vnd.api+json

Body

{
  "data": [
    {
      "data": {
        "type": "contacts",
        "id": "cbebfd5f-815e-47c2-803e-4daf2ab8716b"
      }
    },
    {
      "data": {
        "type": "contacts",
        "id": "bd06aa40-5843-4fb7-8f7b-15020d96e572"
      }
    }
  ]
}

Response

Headers

Body

Fields

data

Type [Contact]

Description An array of Contacts that have just been deleted

Contacts [BULK POST]

an individual element of the data array

For this bulk create endpoint, you are required to send an array of items within the data object.

  • Each member of the array must contain a client generated id to be used for the Contact being created.

  • Each member of the array must contain a type that has the value of 'contacts'.

  • Each member of the array must have an attributes hash of values to be used for the Contact being created.

Request

Endpoint

Body

Response

Headers

Body

Fields

data

Type [Contact / error]

Description Array of both Contact objects that have been successfully created and of errors related to Contact objects that were not created successfully

Contacts [BULK PUT]

Contacts [BULK PUT]

Request

Endpoint

Body

Response

Headers

Body

Fields

data

Type [Contact / error]

Description Array of both Contact objects that have been successfully updated and of errors related to Contact objects that were not updated successfully

Last updated