Create Contact

POST /v1/contacts
application/json

Body

New Contact Params

  • contact object Required

    A contact

    Additional properties are allowed.

    Hide contact attributes Show contact attributes object
    • category enum Required

      Contact category

      Values are person or team.

    • email string(email)

      Email address

    • firstName string

      Contact first name

      Format should match the following pattern: [a-zA-Z][a-zA-Z0-9_]+.

    • function string

      Contact function

    • id integer

      Contact ID

    • insertedAt string(date-time)

      Creation timestamp

    • lastName string

      Contact last name

      Format should match the following pattern: [a-zA-Z][a-zA-Z0-9_]+.

    • tags array[string]

      Contact tags

    • updatedAt string(date-time)

      Update timestamp

Responses

  • 201 application/json

    Contact response

    Hide response attribute Show response attribute object
    • data object

      A contact

      Additional properties are allowed.

      Hide data attributes Show data attributes object
      • category enum Required

        Contact category

        Values are person or team.

      • email string(email)

        Email address

      • firstName string

        Contact first name

        Format should match the following pattern: [a-zA-Z][a-zA-Z0-9_]+.

      • function string

        Contact function

      • id integer

        Contact ID

      • insertedAt string(date-time)

        Creation timestamp

      • lastName string

        Contact last name

        Format should match the following pattern: [a-zA-Z][a-zA-Z0-9_]+.

      • tags array[string]

        Contact tags

      • updatedAt string(date-time)

        Update timestamp
POST /v1/contacts 
curl \
 -X POST http://localhost:4000/v1/contacts \
 -H "Content-Type: application/json" \
 -d '{"contact":{"id":"\u003cuuid v4\u003e","category":"person","last_name":"Muster","first_name":"Melanie"}}'
Request example 
{
  "contact": {
    "id": "<uuid v4>",
    "category": "person",
    "last_name": "Muster",
    "first_name": "Melanie"
  }
}
Response examples (201) 
{
  "data": {
    "id": "<uuid v4>",
    "category": "person",
    "last_name": "Muster",
    "first_name": "Melanie"
  }
}