Create a new contact

Create a new contact and associated Directus user. The contact will have a default review status of "to_review".

Authorization

AuthorizationBearer <token>

In: header

Request Body

emailstring

Valid email address

Formatemail

first_namestring

First name of the contact

Length1 <= length

last_name?string

Last name of the contact

title?string

Job title of the contact

review_status?string

Initial review status

Default"to_review"

Value in"to_review" | "in_review" | "approved" | "cancelled"

Response Body

const body = JSON.stringify({
  "email": "john.doe@example.com",
  "first_name": "John"
})

fetch("https://app.orbiqhq.com/api/v1/contacts", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body
})

const body = JSON.stringify({  "email": "john.doe@example.com",  "first_name": "John"})fetch("https://app.orbiqhq.com/api/v1/contacts", {  method: "POST",  headers: {    "Content-Type": "application/json"  },  body})

{
  "success": true,
  "data": {
    "contact": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "email": "john.doe@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "title": "Security Manager",
      "review_status": "approved",
      "account": {},
      "tenant": "string",
      "directus_user": "string",
      "documents": [
        {
          "documents_id": "string"
        }
      ],
      "access_requests": [
        {}
      ]
    }
  }
}

{
  "error": "Invalid input: email: Invalid email address"
}

Empty

How is this guide?

Create a new contact

Authorization

Request Body

Response Body

200

400

401

500