Sign in
contact

Create a new contact

Changed on
post/contact

Request

  • Base URL: https://api.abby.fr
  • URL: https://api.abby.fr/contact
  • Auth: HTTP bearer

Request body

firstnamestring required

The first name of the contact

lastnamestring required

The last name of the contact

phonestring

The phone number of the contact

jobTitlestring

The job title of the contact

emailsstring[]

The email addresses of the contact

notesstring

Additional notes about the contact

Example request

{
  "firstname": "John",
  "lastname": "Doe",
  "phone": "+1234567890",
  "jobTitle": "Software Engineer",
  "emails": [
    "john.doe@example.com",
    "johnd@work.com"
  ],
  "notes": "Prefers email communication",
  "billingAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY"
  },
  "deliveryAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY"
  },
  "bankInformations": {
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFF",
    "holder": "John Doe"
  },
  "preferences": {
    "paymentMethods": [
      "cheque",
      "stripe"
    ]
  }
}

Response

The contact has been successfully created.

idstring required

Contact ID

emailsstring[]

Contact email addresses

defaultContactboolean

Whether this is the default contact

createdAtnumber required

Contact creation timestamp

archivedAtnumber

Contact archival timestamp

hasBillingsboolean required

Whether the contact has billings

testboolean required

Whether this is a test contact

phonestring

Contact phone number

firstnamestring required

Contact first name

lastnamestring required

Contact last name

jobTitlestring

Contact job title

hasTiersPrestationboolean required

Whether the contact has third-party services

notesstring

Additional notes about the contact

language'fr' | 'en' | 'de' | 'it' | 'nl' | 'pt' | 'es'
currency'EUR' | 'GBP' | 'CHF' | 'USD' | 'AUD' | 'CAD' | 'JPY' | 'CNH' | 'CZK' | 'DKK' | 'BGN' | 'PLN' | 'HUF' | 'RON' | 'SEK' | 'NOK' | 'TRY' | 'BRL' | 'HKD' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'XPF' | 'XOF' | 'XAF'

Preferred currency of the customer

paymentMethodsPaymentMethod[]

Accepted payment methods

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "emails": [
    "john@example.com",
    "johndoe@company.com"
  ],
  "organization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Acme Corp",
    "archivedAt": 1617187200
  },
  "defaultContact": true,
  "createdAt": 1617187200,
  "archivedAt": 1617187200,
  "hasBillings": true,
  "phone": "+33123456789",
  "firstname": "John",
  "lastname": "Doe",
  "billingAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY"
  },
  "deliveryAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY"
  },
  "jobTitle": "Software Engineer",
  "bankInformations": {
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFF",
    "holder": "John Doe"
  },
  "notes": "Prefers email communication",
  "paymentMethods": [
    "cash",
    "credit_card"
  ]
}

Changes

  • bb3dad0e053fRevision changes
    • breaking

      request property ////// was restricted to a list of enum values

    • breaking

      the response's property type changed from no type to array for status

    • warning

      added the new XAF enum value to the //// response property for the response status

    • warning

      added the new XOF enum value to the //// response property for the response status

    • warning

      added the new XPF enum value to the //// response property for the response status

    • info

      api operation id ContactController-createContact removed and replaced with ContactController_createContact

    • info

      added the new XAF enum value to the request property /////////

    • info

      added the new XOF enum value to the request property /////////

    • info

      added the new XPF enum value to the request property /////////

    • info

      added the new cash enum value to the request property //////

    • info

      added the new cheque enum value to the request property //////

    • info

      added the new credit_card enum value to the request property //////

    • info

      added the new direct_debit enum value to the request property //////

    • info

      added the new other enum value to the request property //////

    • info

      added the new paypal enum value to the request property //////

    • info

      added the new stripe enum value to the request property //////

    • info

      added the new transfer enum value to the request property //////

    • info

      added the new universal_employment_service_cheque enum value to the request property //////

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    This list may be incomplete.