Interface: contact import

POST /api/v3/api/import/persons/contact_import

Authentication

  • HTTP BasicAuth with guid and API key

Required HTTP Headers

  • X-Plugin-Version
  • X-Plugin-Identifier

General

  • Most fields are optional and thus may not be content of the response

Supported Formats

  • json

Examples

POST /v3/api/import/persons/contact_import
{ "target_username": "someone@sic.software",
  "contacts": [
    {
      "creation_date": "2018-10-14T08:55:39+02:00",
      "last_change": "2018-10-14T09:42:27+02:00",
      "first_name": "Max",
      "last_name": "Muster",
      "email": "max.muster@example.com",
      "customer_id": "42",
      "company": "Example",
      "language": "German",
      "position": "CEO",
      "street": "Schillerstraße 42",
      "post_code": "74076",
      "city": "Heilbronn",
      "country": "Germany",
      "telephone": "01234 5678900",
      "mobile": "0987 6543210",
      "fax": "01234 5678900"
    },
    {
      <more contact data like above>
    }
  ]
}
202
{
  "max.muster@example.com": "BCFF894460903D45D9866F4F65D06E3BE76865BC"
  <other crm_ids of users, which didn't have field crm_id in request>
}

Errors

Code Description
401 Wrong credentials given
400 Missing crm_id AND email of one contact
403 Invalid or missing X-Plugin-Version / X-Plugin-Identifier header

Params

Param name Description
target_username
optional
valid Email

Validations:

  • Must be a String

For getting access to the interfaces please contact the VERMO support team.