Create or update Contacts

Creates or updates contacts

application/json

Request Body required

• list_items object[] required

  List of entities used for bulk creating, updating contacts

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Created
• Updated

---

Schema

• result object[]

  List of Link id results

  link_id uuid

  Unique entity set by the server to bind some parameters with each other. By default return null value

  success boolean

  describes state of operation

  extended_info string

  Possible values: [created, updated, deleted, entity_not_found]

  Entity state information result

{
  "result": [
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
      "success": true,
      "extended_info": "created"
    }
  ]
}

{
  "result": [
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b1",
      "success": true,
      "extended_info": "created"
    },
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b2",
      "success": true,
      "extended_info": "created"
    },
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b3",
      "success": true,
      "extended_info": "created"
    },
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b4",
      "success": true,
      "extended_info": "created"
    }
  ]
}

{
  "result": [
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b1",
      "success": true,
      "extended_info": "updated"
    },
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b2",
      "success": true,
      "extended_info": "updated"
    },
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b3",
      "success": true,
      "extended_info": "updated"
    },
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b4",
      "success": true,
      "extended_info": "updated"
    }
  ]
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• error object

  Describes the base error user might get

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  Describes the parameter that did not pass a validation

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be a string"
    }
  }
}

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Describes the base error user might get

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  Describes the parameter that did not pass a validation

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be a string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Log In"
  }
}

Loading...